ClassesClasses | | Operators

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfo (Operator)

Name

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

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

Description

With the help of the operator get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo the online-texts concerning a certain operator can be called (see also get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorName). The form of information available for all operators (SlotSlotSlotSlotslot) can be called using the operator query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoQueryOperatorInfo. 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 parallel behavior of an operator.

'parallel_method'

Method of automatic operator parallelization.

'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 concering the correct use of the operator (optional).

'parameter':

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

'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_systemGetSystemGetSystemGetSystem and set_systemset_systemSetSystemSetSystemSetSystem). By adding '.latex' after the slotname, 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

Parameters

OperatorNameOperatorNameOperatorNameOperatorNameoperatorName (input_control)  proc_name HTupleHTupleHtuple (string) (string) (HString) (char*)

Name of the operator on which more information is needed.

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

SlotSlotSlotSlotslot (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Desired information.

Default value: '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", 'example'"example""example""example""example", 'functionality'"functionality""functionality""functionality""functionality", 'html_path'"html_path""html_path""html_path""html_path", '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) HTupleHTupleHtuple (string) (string) (HString) (char*)

Information (empty if no information is available)

Result

The operator get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo 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_keywordsGetKeywordsGetKeywordsGetKeywords, search_operatorsearch_operatorSearchOperatorSearchOperatorSearchOperator, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorName, query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoQueryOperatorInfo, query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfo, get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfo

Possible Successors

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNames, get_param_numget_param_numGetParamNumGetParamNumGetParamNum, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypes

Alternatives

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNames

See also

query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoQueryOperatorInfo, get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfo, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorName, get_param_numget_param_numGetParamNumGetParamNumGetParamNum, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypes

Module

Foundation


ClassesClasses | | Operators