Skip to content

get_operator_infoGetOperatorInfoGetOperatorInfoget_operator_infoget_operator_info🔗

Short description🔗

get_operator_infoGetOperatorInfoGetOperatorInfoget_operator_infoget_operator_info — Get information concerning a HALCON-operator.

Signature🔗

get_operator_info( proc_name OperatorName, string Slot, out string Information )void GetOperatorInfo( const HTuple& OperatorName, const HTuple& Slot, HTuple* Information )static void HOperatorSet.GetOperatorInfo( HTuple operatorName, HTuple slot, out HTuple information )def get_operator_info( operator_name: str, slot: str ) -> Sequence[str]

def get_operator_info_s( operator_name: str, slot: str ) -> strHerror get_operator_info( const char* OperatorName, const char* Slot, char* Information )

Herror T_get_operator_info( const Htuple OperatorName, const Htuple Slot, Htuple* Information )

static HTuple HInfo::GetOperatorInfo( const HString& OperatorName, const HString& Slot )

static HTuple HInfo::GetOperatorInfo( const char* OperatorName, const char* Slot )

static HTuple HInfo::GetOperatorInfo( const wchar_t* OperatorName, const wchar_t* Slot ) (Windows only)

static HTuple HInfo.GetOperatorInfo( string operatorName, string slot )

Description🔗

With the help of the operator get_operator_infoGetOperatorInfo the online-texts concerning a certain operator can be called (see also get_operator_nameGetOperatorName). The form of information available for all operators (Slotslotslot) can be called using the operator query_operator_infoQueryOperatorInfo. For the time being the following slots are available:

  • 'short'"short": Short description of the operator.

  • 'abstract'"abstract": Description of the operator.

  • 'chapter'"chapter": Name(s) of the chapter(s) in the operator hierarchy (chapter, subchapter in the HALCON manual).

  • 'functionality'"functionality": Functionality is equivalent to the object class to which the operator can be assigned.

  • 'keywords'"keywords": Keywords of the operator (optional).

  • 'example'"example": Example for the use of the operator (optional). The operator ‘example.LANGUAGE’ \(\in\) {trias,c,c++,c#,vb.net}) calls up examples for a certain language if available. If the language is not indicated or if no example is available in this language, the TRIAS-example will be returned.

  • 'complexity'"complexity": Complexity of the operator (optional).

  • 'effect'"effect": Not in use so far.

  • 'parallelization'"parallelization": Characteristic timeout and parallel behavior of an operator.

  • ‘execution information’: Characteristic timeout and parallel behavior of an operator.

  • 'parallel_method'"parallel_method": Method of automatic operator parallelization.

  • 'interrupt_mode'"interrupt_mode": Modes of interruption the operator can deal with. See set_operator_timeoutSetOperatorTimeout and interrupt_operatorInterruptOperator on how to use and set these interrupt modes.

  • 'alternatives'"alternatives": Alternative operators (optional).

  • 'see_also'"see_also": Operators containing further information (optional).

  • 'predecessor'"predecessor": Possible and sensible predecessor

  • 'successor'"successor": Possible and sensible successor

  • 'result_state'"result_state": Return value of the operator (2 (H_MSG_TRUE), 3 (H_MSG_FALSE), 5 (H_MSG_FAIL), 4 (H_MSG_VOID) or EXCEPTION).

  • 'attention'"attention": Restrictions and advice concerning the correct use of the operator (optional).

  • 'parameter'"parameter": Names of the parameter of the operator (see also get_param_infoGetParamInfo).

  • 'references'"references": Literary references (optional).

  • 'module'"module": The module to which the operator is assigned.

  • 'dynamic_modules'"dynamic_modules": List of modules the operator can be assigned to by dynamic licensing (depending on its usage).

  • 'html_path'"html_path": The directory where the HTML documentation of the operator resides.

  • 'warning'"warning": Possible warnings for using the operator.

  • 'compute_device'"compute_device": List of compute devices supported by the operator.

The texts will be taken from the operators_[LANG].ref, operators_[LANG].sta, operators_[LANG].key, operators_[LANG].num and operators_[LANG].idx, which will be searched by HALCON in the currently used directory or in the directory ‘help_dir’ (respectively ‘user_help_dir’) (see also get_systemGetSystem and set_systemSetSystem).

Attention🔗

The encoding of the result is UTF-8.

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 on which more information is needed.

Default: 'get_operator_info'"get_operator_info"

Slotslotslot (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Desired information.

Default: 'abstract'"abstract"
List of values: 'abstract', 'alternatives', 'attention', 'chapter', 'chapter_id', 'complexity', 'compute_device', 'dynamic_modules', 'example', 'execution information', 'functionality', 'html_path', 'interrupt_mode', 'keywords', 'module', 'parallel_method', 'parallelization', 'parameter', 'predecessor', 'references', 'result_state', 'see_also', 'short', 'successor', 'warning'"abstract", "alternatives", "attention", "chapter", "chapter_id", "complexity", "compute_device", "dynamic_modules", "example", "execution information", "functionality", "html_path", "interrupt_mode", "keywords", "module", "parallel_method", "parallelization", "parameter", "predecessor", "references", "result_state", "see_also", "short", "successor", "warning"

Informationinformationinformation (output_control) string(-array) → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Information (empty if no information is available)

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

get_keywordsGetKeywords, search_operatorSearchOperator, get_operator_nameGetOperatorName, query_operator_infoQueryOperatorInfo, query_param_infoQueryParamInfo, get_param_infoGetParamInfo

Possible successors

get_param_namesGetParamNames, get_param_numGetParamNum, get_param_typesGetParamTypes

Alternatives

get_param_namesGetParamNames

See also

query_operator_infoQueryOperatorInfo, get_param_infoGetParamInfo, get_operator_nameGetOperatorName, get_param_numGetParamNum, get_param_typesGetParamTypes

Module🔗

Foundation