ClassesClassesClassesClasses | | | | Operators

query_sheet_of_light_paramsT_query_sheet_of_light_paramsQuerySheetOfLightParamsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParams (Operator)

Name

query_sheet_of_light_paramsT_query_sheet_of_light_paramsQuerySheetOfLightParamsquery_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)

Herror T_query_sheet_of_light_params(const Htuple SheetOfLightModelID, const Htuple QueryName, Htuple* GenParamName)

Herror query_sheet_of_light_params(const HTuple& SheetOfLightModelID, const HTuple& QueryName, HTuple* GenParamName)

HTuple HSheetOfLightModel::QuerySheetOfLightParams(const HTuple& QueryName) const

void QuerySheetOfLightParams(const HTuple& SheetOfLightModelID, const HTuple& QueryName, HTuple* GenParamName)

HTuple HSheetOfLightModel::QuerySheetOfLightParams(const HString& QueryName) const

HTuple HSheetOfLightModel::QuerySheetOfLightParams(const char* QueryName) const

void HOperatorSetX.QuerySheetOfLightParams(
[in] VARIANT SheetOfLightModelID, [in] VARIANT QueryName, [out] VARIANT* GenParamName)

VARIANT HSheetOfLightModelX.QuerySheetOfLightParams([in] BSTR QueryName)

static void HOperatorSet.QuerySheetOfLightParams(HTuple sheetOfLightModelID, HTuple queryName, out HTuple genParamName)

HTuple HSheetOfLightModel.QuerySheetOfLightParams(string queryName)

Description

The operator query_sheet_of_light_paramsquery_sheet_of_light_paramsQuerySheetOfLightParamsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParams returns the names of the generic parameters that are supported by the following operators create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModel, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParam, get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParam and get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResult. The parameter QueryNameQueryNameQueryNameQueryNameQueryNamequeryName 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_modelCreateSheetOfLightModelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModel - 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_paramSetSheetOfLightParamset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParam - 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_paramGetSheetOfLightParamget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParam - 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_resultGetSheetOfLightResultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResult - 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.

Parallelization

Parameters

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID (input_control)  sheet_of_light_model HSheetOfLightModel, HTupleHTupleHSheetOfLightModel, HTupleHSheetOfLightModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the sheet-of-light model.

QueryNameQueryNameQueryNameQueryNameQueryNamequeryName (input_control)  attribute.name HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the parameter group.

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

GenParamNameGenParamNameGenParamNameGenParamNameGenParamNamegenParamName (output_control)  attribute.value-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

List containing the names of the supported generic parameters.

Result

The operator query_sheet_of_light_paramsquery_sheet_of_light_paramsQuerySheetOfLightParamsquery_sheet_of_light_paramsQuerySheetOfLightParamsQuerySheetOfLightParams 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_modelCreateSheetOfLightModelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModel, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParam, get_sheet_of_light_paramget_sheet_of_light_paramGetSheetOfLightParamget_sheet_of_light_paramGetSheetOfLightParamGetSheetOfLightParam, get_sheet_of_light_resultget_sheet_of_light_resultGetSheetOfLightResultget_sheet_of_light_resultGetSheetOfLightResultGetSheetOfLightResult

Module

3D Metrology


ClassesClassesClassesClasses | | | | Operators