Operator Reference

HALCON Operator Reference / System / Information

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

ClassesClasses | | Operators

get_param_namesT_get_param_namesGetParamNamesGetParamNamesget_param_names (Operator)

get_param_namesT_get_param_namesGetParamNamesGetParamNamesget_param_names — Get the names of the parameters of a HALCON-operator.

Signature

get_param_names( : : OperatorName : InpObjPar, OutpObjPar, InpCtrlPar, OutpCtrlPar)

Herror T_get_param_names(const Htuple OperatorName, Htuple* InpObjPar, Htuple* OutpObjPar, Htuple* InpCtrlPar, Htuple* OutpCtrlPar)

void GetParamNames(const HTuple& OperatorName, HTuple* InpObjPar, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar)

static HTuple HInfo::GetParamNames(const HString& OperatorName, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar)

static HTuple HInfo::GetParamNames(const char* OperatorName, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar)

static HTuple HInfo::GetParamNames(const wchar_t* OperatorName, HTuple* OutpObjPar, HTuple* InpCtrlPar, HTuple* OutpCtrlPar)   ( Windows only)

static void HOperatorSet.GetParamNames(HTuple operatorName, out HTuple inpObjPar, out HTuple outpObjPar, out HTuple inpCtrlPar, out HTuple outpCtrlPar)

static HTuple HInfo.GetParamNames(string operatorName, out HTuple outpObjPar, out HTuple inpCtrlPar, out HTuple outpCtrlPar)

def get_param_names(operator_name: str) -> Tuple[Sequence[str], Sequence[str], Sequence[str], Sequence[str]]

Description

For the HALCON-operator indicated in OperatorNameOperatorNameOperatorNameoperatorNameoperator_name the operator get_param_namesget_param_namesGetParamNamesGetParamNamesget_param_names returns the names of the input objects, the output objects, of the input control parameters and the output control parameters.

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_names' "get_param_names" "get_param_names" "get_param_names" "get_param_names"

InpObjParInpObjParInpObjParinpObjParinp_obj_par (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the input objects.

OutpObjParOutpObjParOutpObjParoutpObjParoutp_obj_par (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the output objects.

InpCtrlParInpCtrlParInpCtrlParinpCtrlParinp_ctrl_par (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the input control parameters.

OutpCtrlParOutpCtrlParOutpCtrlParoutpCtrlParoutp_ctrl_par (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Names of the output control parameters.

Result

The operator get_param_namesget_param_namesGetParamNamesGetParamNamesget_param_names returns the value 2 ( H_MSG_TRUE) if the name of the operator exists and the helpfiles are available. 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_numget_param_numGetParamNumGetParamNumget_param_num, 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_numget_param_numGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesget_param_types, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameget_operator_name

Module

Foundation

---

ClassesClasses | | Operators