Skip to content

get_param_numGetParamNumGetParamNumget_param_numget_param_num🔗

Short description🔗

get_param_numGetParamNumGetParamNumget_param_numget_param_num — Get number of the different parameter classes of a HALCON-operator.

Signature🔗

get_param_num( proc_name OperatorName, out string CName, out integer InpObjPar, out integer OutpObjPar, out integer InpCtrlPar, out integer OutpCtrlPar, out string Type )void GetParamNum( const HTuple& OperatorName, HTuple* CName, HTuple* InpObjPar, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar, HTuple* Type )static void HOperatorSet.GetParamNum( HTuple operatorName, out HTuple CName, out HTuple inpObjPar, out HTuple outpObjPar, out HTuple inpCtrlPar, out HTuple outpCtrlPar, out HTuple type )def get_param_num( operator_name: str ) -> Tuple[str, int, int, int, int, str]

Herror get_param_num( const char* OperatorName, char* CName, Hlong* InpObjPar, Hlong* OutpObjPar, Hlong* InpCtrlPar, Hlong* OutpCtrlPar, char* Type )

Herror T_get_param_num( const Htuple OperatorName, Htuple* CName, Htuple* InpObjPar, Htuple* OutpObjPar, Htuple* InpCtrlPar, Htuple* OutpCtrlPar, Htuple* Type )

static HString HInfo::GetParamNum( const HString& OperatorName, Hlong* InpObjPar, Hlong* OutpObjPar, Hlong* InpCtrlPar, Hlong* OutpCtrlPar, HString* Type )

static HString HInfo::GetParamNum( const char* OperatorName, Hlong* InpObjPar, Hlong* OutpObjPar, Hlong* InpCtrlPar, Hlong* OutpCtrlPar, HString* Type )

static HString HInfo::GetParamNum( const wchar_t* OperatorName, Hlong* InpObjPar, Hlong* OutpObjPar, Hlong* InpCtrlPar, Hlong* OutpCtrlPar, HString* Type ) (Windows only)

static string HInfo.GetParamNum( string operatorName, out int inpObjPar, out int outpObjPar, out int inpCtrlPar, out int outpCtrlPar, out string type )

Description🔗

The operator get_param_numGetParamNum returns the number of the input and output object parameters, as well as the input and output control parameters for the indicated HALCON-operator. Further, you will receive the name of the C-function (CNameCNamecname) called by the operator. The output parameter Typetypetype indicates, whether the operator is a system operator or an user procedure.

Execution information🔗

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🔗

OperatorNameoperatorNameoperator_name (input_control) proc_name → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the operator.

Default: 'get_param_num'"get_param_num"

CNameCNamecname (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the called C-function.

InpObjParinpObjParinp_obj_par (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of the input object parameters.

OutpObjParoutpObjParoutp_obj_par (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of the output object parameters.

InpCtrlParinpCtrlParinp_ctrl_par (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of the input control parameters.

OutpCtrlParoutpCtrlParoutp_ctrl_par (output_control) integer → (integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)

Number of the output control parameters.

Typetypetype (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

System operator or user procedure.

Suggested values: 'system', 'user'"system", "user"

Result🔗

The operator get_param_numGetParamNum returns the value 2 (H_MSG_TRUE) if the name of the operator exists. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

get_keywordsGetKeywords, search_operatorSearchOperator, get_operator_nameGetOperatorName, get_operator_infoGetOperatorInfo

Possible successors

get_param_typesGetParamTypes

Alternatives

get_operator_infoGetOperatorInfo, get_param_infoGetParamInfo

See also

get_param_namesGetParamNames, get_param_typesGetParamTypes, get_operator_nameGetOperatorName

Module🔗

Foundation