Operator Reference

HALCON Operator Reference / System / Information

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

get_param_numget_param_numGetParamNumGetParamNumget_param_num (Operator)

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

Signature

get_param_num( : : OperatorName : CName, InpObjPar, OutpObjPar, InpCtrlPar, OutpCtrlPar, Type)

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)

void GetParamNum(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 void HOperatorSet.GetParamNum(HTuple operatorName, out HTuple CName, out HTuple inpObjPar, out HTuple outpObjPar, out HTuple inpCtrlPar, out HTuple outpCtrlPar, out HTuple type)

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

def get_param_num(operator_name: str) -> Tuple[str, int, int, int, int, str]

Description

The operator get_param_numget_param_numGetParamNumGetParamNumget_param_num 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 (CNameCNameCNameCNamecname) called by the operator. The output parameter TypeTypeTypetypetype indicates, whether the operator is a system operator or an user procedure.

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

OperatorNameOperatorNameOperatorNameoperatorNameoperator_name (input_control)  proc_name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the operator.

Default: 'get_param_num' "get_param_num" "get_param_num" "get_param_num" "get_param_num"

CNameCNameCNameCNamecname (output_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the called C-function.

InpObjParInpObjParInpObjParinpObjParinp_obj_par (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of the input object parameters.

OutpObjParOutpObjParOutpObjParoutpObjParoutp_obj_par (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of the output object parameters.

InpCtrlParInpCtrlParInpCtrlParinpCtrlParinp_ctrl_par (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of the input control parameters.

OutpCtrlParOutpCtrlParOutpCtrlParoutpCtrlParoutp_ctrl_par (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Number of the output control parameters.

TypeTypeTypetypetype (output_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

System operator or user procedure.

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

Result

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

Possible Predecessors

get_keywordsget_keywordsGetKeywordsGetKeywordsget_keywords, search_operatorsearch_operatorSearchOperatorSearchOperatorsearch_operator, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameget_operator_name, get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info

Possible Successors

get_param_typesget_param_typesGetParamTypesGetParamTypesget_param_types

Alternatives

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info, get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info

See also

get_param_namesget_param_namesGetParamNamesGetParamNamesget_param_names, get_param_typesget_param_typesGetParamTypesGetParamTypesget_param_types, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameget_operator_name

Module

Foundation

---

ClassesClasses | | Operators