Operator Reference

HALCON Operator Reference / System / Information
ClassesClasses | | Operators

get_operator_nameT_get_operator_nameGetOperatorNameGetOperatorNameget_operator_name (Operator)

get_operator_nameT_get_operator_nameGetOperatorNameGetOperatorNameget_operator_name — Get operators with the given string as a substring of their name.

Signature

get_operator_name( : : Pattern : OperatorNames)

Herror T_get_operator_name(const Htuple Pattern, Htuple* OperatorNames)

void GetOperatorName(const HTuple& Pattern, HTuple* OperatorNames)

static HTuple HInfo::GetOperatorName(const HString& Pattern)

static HTuple HInfo::GetOperatorName(const char* Pattern)

static HTuple HInfo::GetOperatorName(const wchar_t* Pattern)   ( Windows only)

static void HOperatorSet.GetOperatorName(HTuple pattern, out HTuple operatorNames)

static HTuple HInfo.GetOperatorName(string pattern)

def get_operator_name(pattern: str) -> Sequence[str]

Description

The operator get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameget_operator_name takes a string (PatternPatternPatternpatternpattern) as input and searches all HALCON-operators having this string as a substring in their name. If an empty string is entered, the names of all operators available will be returned.

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

PatternPatternPatternpatternpattern (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Substring of the seeked names (empty <=> all names).

Default: 'info' "info" "info" "info" "info"

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

Detected operator names.

Result

The operator get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameget_operator_name returns the value 2 ( H_MSG_TRUE) if the helpfiles are available. Otherwise an exception is raised.

Possible Successors

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info, get_param_namesget_param_namesGetParamNamesGetParamNamesget_param_names, get_param_numget_param_numGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesget_param_types

Alternatives

search_operatorsearch_operatorSearchOperatorSearchOperatorsearch_operator

See also

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info, get_param_namesget_param_namesGetParamNamesGetParamNamesget_param_names, get_param_numget_param_numGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesget_param_types

Module

Foundation

ClassesClasses | | Operators