Get information concerning a HALCON-procedure.
With the help of the operator ::get_operator_info the online-texts concerning a certain procedure can be called (see also ::get_operator_name). The form of information available for all procedures (Slot) can be called using the operator ::query_operator_info. For the time being the following slots are available: 'short' Short description of the procedure. 'abstract' Description of the procedure. 'procedure_class' Name(s) of the chapter(s) in the procedure hierarchy (chapter, subchapter in the Halcon manual). 'functionality' Functionality is equivalent to the object class to which the procedure can be assigned. 'keywords' Keywords of the procedure (optional). 'example' Example for the use of the procedure (optional). The operator 'example.LANGUAGE' (LANGUAGE={c,c++,smalltalk,trias}) calls 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' Mathematical complexity of the procedure (optional). 'effect' Not in use so far. 'alternatives' Alternative procedures (optional). 'see_also' Procedures containing further information (optional). 'predecessor' Possible and sensible predecessor 'successor' Possible and sensible successor 'result_state' Return values of the procedure (TRUE, FALSE, FAIL, VOID, or EXCEPTION). 'attention' Restrictions and advice concering the correct use of the procedure (optional). 'parameter' Names of the parameters of the procedure (see also ::get_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. The texts will be taken from the files english.hlp, english.sta, english.key, english.num und english.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_system and ::set_system). By adding '.latex' after the slotname, the text of slots containing textual information can be made available in notation.
|
ProcName (input_control) |
proc_name -> HTuple.char * |
| Name of the procedure on which more information is needed. | |
| Default value: 'get_operator_info' | |
|
Slot (input_control) |
string -> HTuple.char * |
| Desired information. | |
| Default value: 'abstract' | |
| List of values: 'short', 'abstract', 'procedure_class', 'functionality', 'effect', 'complexity', 'predecessor', 'successor', 'alternatives', 'see_also', 'keywords', 'example', 'attention', 'result_state', 'return_value', 'references', 'sourcefiles', 'deffile', 'module', 'html_path' | |
|
Information (output_control) |
string-array -> HTuple.char * |
| Information (empty if no information is available) | |
The operator ::get_operator_info returns the value H_MSG_TRUE if the parameters are correct and the helpfiles are availabe. Otherwise an exception handling is raised.
::get_keywords, ::search_operator, ::get_operator_name, ::query_operator_info, ::query_param_info, ::get_param_info
::get_param_names, ::get_param_num, ::get_param_types
::query_operator_info, ::get_param_info, ::get_operator_name, ::get_param_num, ::get_param_types
Image / region / XLD management
