get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info (Operator)

Name

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info — Informationen zu einem HALCON-Operator.

Signatur

Beschreibung

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfoget_operator_info dient zur Abfrage der Online-Texte zu einem vorgegebenen Operator (siehe auch get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorNameget_operator_name). Die Art der Information (SlotSlotSlotSlotslotslot), die für jeden Operator zur Verfügung stehen, lassen sich mittels query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoQueryOperatorInfoquery_operator_info abfragen. Derzeit werden folgende Slots angeboten:

'short':

Kurzbeschreibung des Operators.

'abstract':

Beschreibung des Operators.

'chapter':

Kapitelname(n) in der Operatorhierarchie (Kapitel, Unterkapitel im HALCON-Manual).

'functionality':

Funktionalität, ist gleich der Objektklasse, der der Operator zugeordnet werden kann.

'keywords':

Schlüsselwörter zu dem Operator (optional).

'example':

Beispiel für die Anwendung des Operators (optional). Mit 'example.SPRACHE' (SPRACHE) können Beispiele für eine bestimmte Sprache abgefragt werden, insofern sie vorhanden sind. Wird die Sprache nicht mit angegeben oder ist in dieser Sprache kein Beispiel vorhandenen, wird das TRIAS-Beispiel ausgegeben.

'complexity':

Komplexität des Operators (optional).

'effect':

Momentan nicht genutzt.

'parallelization':

Charakteristik des Operators bezüglich parallelen Verhaltens und Timeouts.

'execution information':

Charakteristik des Operators bezüglich parallelen Verhaltens und Timeouts.

'parallel_method':

Methoden der von einem Operator unterstützten automatischen Parallelisierung.

'interrupt_mode':

Modi der Unterbrechbarkeit, die von einem spezifischen Operator unterstützt werden. In der Dokumentation von set_operator_timeoutset_operator_timeoutSetOperatorTimeoutSetOperatorTimeoutSetOperatorTimeoutset_operator_timeout und interrupt_operatorinterrupt_operatorInterruptOperatorInterruptOperatorInterruptOperatorinterrupt_operator ist beschrieben, wie diese Modi genutzt und gesetzt werden können.

'alternatives':

Alternativen zum Operator (optional).

'see_also':

Operatoren mit weitergehenden Informationen (optional).

'predecessor':

Mögliche und sinnvolle Vorgängerprozedur

'successor':

Mögliche und sinnvolle Nachfolgerprozedur

'result_state':

Rückgabewert des Operators (TRUE, FALSE, FAIL, VOID oder EXCEPTION).

'attention':

Einschränkungen und Hinweise zur korrekten Anwendung des Operators (optional).

'parameter':

Namen der Parameter des Operators (siehe get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info).

'references':

Literaturverweise (optional).

'module':

Das Modul, zu dem der Operator gehört.

'html_path':

Das Verzeichnis, in dem die HTML-Dokumentation des Operators steht.

'warning':

Eventuelle Warnungen zur Verwendung des Operators.

'compute_device':

Liste von Compute Devices, die vom Operator unterstützt werden.

Die Texte werden den Dateien operators_[LANG].ref, operators_[LANG].sta, operators_[LANG].key, operators_[LANG].num und operators_[LANG].idx entnommen, die HALCON im aktuellen Verzeichnis und im Verzeichnis 'help_dir' (siehe get_systemget_systemGetSystemGetSystemGetSystemget_system und set_systemset_systemSetSystemSetSystemSetSystemset_system) sucht. Bei Slots mit textuellen Informationen kann mit '.latex' nach dem Slotnamen der Text in LaTeX Notation geholt werden.

Achtung

Das Encoding der Ergebnisse ist UTF-8.

Ausführungsinformationen

• Multithreading-Typ: reentrant (läuft parallel zu nicht-exklusiven Operatoren).
• Multithreading-Bereich: global (kann von jedem Thread aufgerufen werden).
• Wird ohne Parallelisierung verarbeitet.

Parameter

Ergebnis

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfoget_operator_info liefert den Wert TRUE, wenn die Parameter korrekt sind und die Hilfsdateien verfügbar sind. Sonst wird eine Fehlerbehandlung durchgeführt.

Vorgänger

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

Nachfolger

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNamesget_param_names, get_param_numget_param_numGetParamNumGetParamNumGetParamNumget_param_num, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypesget_param_types

Alternativen

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNamesget_param_names

Siehe auch

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

Modul

Foundation