query_sheet_of_light_paramsT_query_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsquery_sheet_of_light_params (Operator)
Name
query_sheet_of_light_paramsT_query_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsquery_sheet_of_light_params — For a given sheet-of-light model get the names of the generic iconic
or control parameters that can be used in the different
sheet-of-light operators.
Signature
Description
The operator query_sheet_of_light_paramsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsQuerySheetOfLightParamsquery_sheet_of_light_params returns the names of
the generic parameters that are supported by the following operators
create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param,
get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param and get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result.
The parameter QueryNameQueryNameQueryNameQueryNamequeryNamequery_name is used to select the desired
parameter group:
- 'create_model_params'"create_model_params""create_model_params""create_model_params""create_model_params""create_model_params":
-
create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model - Parameters for adjusting
the sheet-of-light model during its creation.
- 'set_model_params'"set_model_params""set_model_params""set_model_params""set_model_params""set_model_params":
-
set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param - Parameters for adjusting
the parameters of an available sheet-of-light model.
- 'get_model_params'"get_model_params""get_model_params""get_model_params""get_model_params""get_model_params":
-
get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param - Parameters for querying
the values of the parameters of a sheet-of-light model.
- 'get_result_objects'"get_result_objects""get_result_objects""get_result_objects""get_result_objects""get_result_objects":
-
get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result - Parameters for accessing
the iconic objects resulting from the measurement.
The returned parameter list does not depend on the current state of the
model or its results.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id (input_control) sheet_of_light_model → HSheetOfLightModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the sheet-of-light model.
QueryNameQueryNameQueryNameQueryNamequeryNamequery_name (input_control) attribute.name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the parameter group.
Default:
'create_model_params'
"create_model_params"
"create_model_params"
"create_model_params"
"create_model_params"
"create_model_params"
List of values:
'create_model_params'"create_model_params""create_model_params""create_model_params""create_model_params""create_model_params", 'get_model_params'"get_model_params""get_model_params""get_model_params""get_model_params""get_model_params", 'get_result_objects'"get_result_objects""get_result_objects""get_result_objects""get_result_objects""get_result_objects", 'set_model_params'"set_model_params""set_model_params""set_model_params""set_model_params""set_model_params"
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (output_control) attribute.value-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
List containing the names of the supported generic
parameters.
Result
The operator query_sheet_of_light_paramsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsQuerySheetOfLightParamsquery_sheet_of_light_params returns the value 2 (
H_MSG_TRUE)
if the given parameters are correct.
Otherwise, an exception will be raised.
Possible Successors
create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model,
set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param,
get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamGetSheetOfLightParamget_sheet_of_light_param,
get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultGetSheetOfLightResultget_sheet_of_light_result
Module
3D Metrology