Operator Reference

HALCON Operator Reference / System / Information
ClassesClasses | | Operators

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info (Operator)

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info — Get information concerning a HALCON-operator.

Signature

get_operator_info( : : OperatorName, Slot : Information)

Herror get_operator_info(const char* OperatorName, const char* Slot, char* Information)

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

void GetOperatorInfo(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 void HOperatorSet.GetOperatorInfo(HTuple operatorName, HTuple slot, out HTuple information)

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

def get_operator_info(operator_name: str, slot: str) -> Sequence[str]

def get_operator_info_s(operator_name: str, slot: str) -> str

Description

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

'short'"short""short""short""short":

Short description of the operator.

'abstract'"abstract""abstract""abstract""abstract":

Description of the operator.

'chapter'"chapter""chapter""chapter""chapter":

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

'functionality'"functionality""functionality""functionality""functionality":

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

'keywords'"keywords""keywords""keywords""keywords":

Keywords of the operator (optional).

'example'"example""example""example""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""complexity""complexity""complexity":

Complexity of the operator (optional).

'effect'"effect""effect""effect""effect":

Not in use so far.

'parallelization'"parallelization""parallelization""parallelization""parallelization":

Characteristic timeout and parallel behavior of an operator.

'execution information':

Characteristic timeout and parallel behavior of an operator.

'parallel_method'"parallel_method""parallel_method""parallel_method""parallel_method":

Method of automatic operator parallelization.

'interrupt_mode'"interrupt_mode""interrupt_mode""interrupt_mode""interrupt_mode":

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

'alternatives'"alternatives""alternatives""alternatives""alternatives":

Alternative operators (optional).

'see_also'"see_also""see_also""see_also""see_also":

Operators containing further information (optional).

'predecessor'"predecessor""predecessor""predecessor""predecessor":

Possible and sensible predecessor

'successor'"successor""successor""successor""successor":

Possible and sensible successor

'result_state'"result_state""result_state""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""attention""attention""attention":

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

'parameter'"parameter""parameter""parameter""parameter":

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

'references'"references""references""references""references":

Literary references (optional).

'module'"module""module""module""module":

The module to which the operator is assigned.

'dynamic_modules'"dynamic_modules""dynamic_modules""dynamic_modules""dynamic_modules":

List of modules the operator can be assigned to by dynamic licensing (depending on its usage).

'html_path'"html_path""html_path""html_path""html_path":

The directory where the HTML documentation of the operator resides.

'warning'"warning""warning""warning""warning":

Possible warnings for using the operator.

'compute_device'"compute_device""compute_device""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_systemget_systemGetSystemGetSystemget_system and set_systemset_systemSetSystemSetSystemset_system).

Attention

The encoding of the result is UTF-8.

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

Default: 'get_operator_info' "get_operator_info" "get_operator_info" "get_operator_info" "get_operator_info"

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

Desired information.

Default: 'abstract' "abstract" "abstract" "abstract" "abstract"

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

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

Information (empty if no information is available)

Result

The operator get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_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_keywordsGetKeywordsGetKeywordsget_keywords, search_operatorsearch_operatorSearchOperatorSearchOperatorsearch_operator, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameget_operator_name, query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoquery_operator_info, query_param_infoquery_param_infoQueryParamInfoQueryParamInfoquery_param_info, get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info

Possible Successors

get_param_namesget_param_namesGetParamNamesGetParamNamesget_param_names, get_param_numget_param_numGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesget_param_types

Alternatives

get_param_namesget_param_namesGetParamNamesGetParamNamesget_param_names

See also

query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoquery_operator_info, get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameget_operator_name, get_param_numget_param_numGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesget_param_types

Module

Foundation

ClassesClasses | | Operators