ClassesClassesClassesClasses | | | | Operators

get_param_typesT_get_param_typesGetParamTypesget_param_typesGetParamTypesGetParamTypes (Operator)

Name

get_param_typesT_get_param_typesGetParamTypesget_param_typesGetParamTypesGetParamTypes — Get default data type for the control parameters of a HALCON-operator.

Signature

get_param_types( : : ProcName : InpCtrlParType, OutpCtrlParType)

Herror T_get_param_types(const Htuple ProcName, Htuple* InpCtrlParType, Htuple* OutpCtrlParType)

Herror get_param_types(const HTuple& ProcName, HTuple* InpCtrlParType, HTuple* OutpCtrlParType)

void GetParamTypes(const HTuple& ProcName, HTuple* InpCtrlParType, HTuple* OutpCtrlParType)

static HTuple HInfo::GetParamTypes(const HString& ProcName, HTuple* OutpCtrlParType)

static HTuple HInfo::GetParamTypes(const char* ProcName, HTuple* OutpCtrlParType)

void HOperatorSetX.GetParamTypes(
[in] VARIANT ProcName, [out] VARIANT* InpCtrlParType, [out] VARIANT* OutpCtrlParType)

VARIANT HInfoX.GetParamTypes(
[in] BSTR ProcName, [out] VARIANT* OutpCtrlParType)

static void HOperatorSet.GetParamTypes(HTuple procName, out HTuple inpCtrlParType, out HTuple outpCtrlParType)

static HTuple HInfo.GetParamTypes(string procName, out HTuple outpCtrlParType)

Description

The operator get_param_typesget_param_typesGetParamTypesget_param_typesGetParamTypesGetParamTypes returns the default data type for each input and output control parameter. The default type of a parameter is the type used in “simple mode” in HALCON/C. This concerns parameters which allow more than one type as for example write_stringwrite_stringWriteStringwrite_stringWriteStringWriteString. Hereby the types of input parameters are combined in the variable InpCtrlParTypeInpCtrlParTypeInpCtrlParTypeInpCtrlParTypeInpCtrlParTypeinpCtrlParType, whereas the types of output parameters are combined in the variable OutpCtrlParTypeOutpCtrlParTypeOutpCtrlParTypeOutpCtrlParTypeOutpCtrlParTypeoutpCtrlParType. The following types are possible:

'integer':

an integer.

'integer tuple':

an integer or a tuple of integers.

'real':

a floating point number.

'real tuple':

a floating point number or a tuple of floating point numbers.

'string':

a string.

'string tuple':

a string or a tuple of strings.

'no_default':

individual value of which the type cannot be determined.

'no_default tuple':

individual value or tuple of values of which the type cannot be determined.

'default':

individual value of unknown type, whereby the systems assumes it to be an 'integer'.

Parallelization

Parameters

ProcNameProcNameProcNameProcNameProcNameprocName (input_control)  proc_name HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of the operator.

Default value: 'get_param_types' "get_param_types" "get_param_types" "get_param_types" "get_param_types" "get_param_types"

InpCtrlParTypeInpCtrlParTypeInpCtrlParTypeInpCtrlParTypeInpCtrlParTypeinpCtrlParType (output_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Default type of the input control parameters.

OutpCtrlParTypeOutpCtrlParTypeOutpCtrlParTypeOutpCtrlParTypeOutpCtrlParTypeoutpCtrlParType (output_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Default type of the output control parameters.

Result

The operator get_param_typesget_param_typesGetParamTypesget_param_typesGetParamTypesGetParamTypes returns the value 2 (H_MSG_TRUE) if the parameters are correct and the helpfiles are availabe. Otherwise an exception is raised.

Possible Predecessors

get_keywordsget_keywordsGetKeywordsget_keywordsGetKeywordsGetKeywords, search_operatorsearch_operatorSearchOperatorsearch_operatorSearchOperatorSearchOperator, get_operator_nameget_operator_nameGetOperatorNameget_operator_nameGetOperatorNameGetOperatorName, get_operator_infoget_operator_infoGetOperatorInfoget_operator_infoGetOperatorInfoGetOperatorInfo

Alternatives

get_param_infoget_param_infoGetParamInfoget_param_infoGetParamInfoGetParamInfo

See also

get_param_namesget_param_namesGetParamNamesget_param_namesGetParamNamesGetParamNames, get_param_numget_param_numGetParamNumget_param_numGetParamNumGetParamNum, get_operator_infoget_operator_infoGetOperatorInfoget_operator_infoGetOperatorInfoGetOperatorInfo, get_operator_nameget_operator_nameGetOperatorNameget_operator_nameGetOperatorNameGetOperatorName

Module

Foundation


ClassesClassesClassesClasses | | | | Operators