get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info (Operator)

Name

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info — Get information concerning a HALCON-operator.

Signature

Description

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

'short':

Short description of the operator.

'abstract':

Description of the operator.

'chapter':

Name(s) of the chapter(s) in the operator hierarchy (chapter, subchapter in the HALCON manual).

'functionality':

Functionality is equivalent to the object class to which the operator can be assigned.

'keywords':

Keywords of the operator (optional).

'example':

Example for the use of the operator (optional). The operator 'example.LANGUAGE' 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 of the operator (optional).

'effect':

Not in use so far.

'parallelization':

Characteristic timeout and parallel behavior of an operator.

'execution information':

Characteristic timeout and parallel behavior of an operator.

'parallel_method':

Method of automatic operator parallelization.

'interrupt_mode':

Modes of interruption the operator can deal with. See set_operator_timeoutset_operator_timeoutSetOperatorTimeoutSetOperatorTimeoutSetOperatorTimeoutset_operator_timeout and interrupt_operatorinterrupt_operatorInterruptOperatorInterruptOperatorInterruptOperatorinterrupt_operator on how to use and set these interrupt modes.

'alternatives':

Alternative operators (optional).

'see_also':

Operators containing further information (optional).

'predecessor':

Possible and sensible predecessor

'successor':

Possible and sensible successor

'result_state':

Return value of the operator (TRUE, FALSE, FAIL, VOID or EXCEPTION).

'attention':

Restrictions and advice concerning the correct use of the operator (optional).

'parameter':

Names of the parameter of the operator (see also get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info).

'references':

Literary references (optional).

'module':

The module to which the operator is assigned.

'html_path':

The directory where the HTML documentation of the operator resides.

'warning':

Possible warnings for using the operator.

'compute_device':

List of compute devices supported by the operator.

The texts will be taken from the files 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_systemget_systemGetSystemGetSystemGetSystemget_system and set_systemset_systemSetSystemSetSystemSetSystemset_system). By adding '.latex' after the slot name, the text of slots containing textual information can be made available in LaTeX notation.

Attention

The encoding of the result is ISO 8859-1 for English and German, and UTF-8 for Japanese.

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

Result

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

Possible Predecessors

get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywordsget_keywords, search_operatorsearch_operatorSearchOperatorSearchOperatorSearchOperatorsearch_operator, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorNameget_operator_name, query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoQueryOperatorInfoquery_operator_info, query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfoquery_param_info, get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info

Possible Successors

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNamesget_param_names, get_param_numget_param_numGetParamNumGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypesget_param_types

Alternatives

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNamesget_param_names

See also

query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoQueryOperatorInfoquery_operator_info, get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorNameget_operator_name, get_param_numget_param_numGetParamNumGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypesget_param_types

Module

Foundation