query_sheet_of_light_paramsT_query_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParams (Operator)

Name

query_sheet_of_light_paramsT_query_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParams — 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

query_sheet_of_light_params( : : SheetOfLightModelID, QueryName : GenParamName)

Description

The operator query_sheet_of_light_paramsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsQuerySheetOfLightParams returns the names of the generic parameters that are supported by the following operators create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModel, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamSetSheetOfLightParam, get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamGetSheetOfLightParam and get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultGetSheetOfLightResult. The parameter QueryNameQueryNameQueryNameQueryNamequeryName is used to select the desired parameter group:

'create_model_params'"create_model_params""create_model_params""create_model_params""create_model_params":

create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModel - 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_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamSetSheetOfLightParam - 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_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamGetSheetOfLightParam - 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_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultGetSheetOfLightResult - 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

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID (input_control) sheet_of_light_model → (integer)

Handle of the sheet-of-light model.

QueryNameQueryNameQueryNameQueryNamequeryName (input_control) attribute.name → (string)

Name of the parameter group.

Default value: '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", '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", 'set_model_params'"set_model_params""set_model_params""set_model_params""set_model_params"

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (output_control) attribute.value-array → (string)

List containing the names of the supported generic parameters.

Result

The operator query_sheet_of_light_paramsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParamsQuerySheetOfLightParams 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_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModel, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamSetSheetOfLightParam, get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParamGetSheetOfLightParam, get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResultGetSheetOfLightResult

Module

3D Metrology

Operators