HALCON Website / HALCON Operator-Referenz / System / Information
KlassenKlassen | | Operatoren

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfo (Operator)

Name

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfo — Informationen zu einem HALCON-Operator.

Signatur

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)   (Nur Windows)

static void HOperatorSet.GetOperatorInfo(HTuple operatorName, HTuple slot, out HTuple information)

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

Beschreibung

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo dient zur Abfrage der Online-Texte zu einem vorgegebenen Operator (siehe auch get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorName). Die Art der Information (SlotSlotSlotSlotslot), die für jeden Operator zur Verfügung stehen, lassen sich mittels query_operator_infoquery_operator_infoQueryOperatorInfoQueryOperatorInfoQueryOperatorInfo 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 parallelen Verhaltens eines Operators.

'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_timeoutSetOperatorTimeoutSetOperatorTimeoutSetOperatorTimeout und interrupt_operatorinterrupt_operatorInterruptOperatorInterruptOperatorInterruptOperator 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_infoGetParamInfoGetParamInfoGetParamInfo).

'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_systemGetSystemGetSystemGetSystem und set_systemset_systemSetSystemSetSystemSetSystem) 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 ISO 8859-1 für Englisch und Deutsch sowie UTF-8 für Japanisch.

Ausführungsinformationen

Parameter

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

Name des Operators, zu dem Information benötigt werden.

Defaultwert: 'get_operator_info' "get_operator_info" "get_operator_info" "get_operator_info" "get_operator_info"

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

Gewünschte Information.

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

Werteliste: '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", '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) → HTupleHTupleHtuple (string) (string) (HString) (char*)

Information (leer, falls keine Information vorhanden ist)

Ergebnis

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo liefert den Wert 2 (H_MSG_TRUE), wenn die Parameter korrekt sind und die Hilfsdateien verfügbar sind. Sonst wird eine Fehlerbehandlung durchgeführt.

Vorgänger

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

Nachfolger

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNames, get_param_numget_param_numGetParamNumGetParamNumGetParamNum, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypes

Alternativen

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNames

Siehe auch

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

Modul

Foundation

KlassenKlassen | | Operatoren
HALCON Operator-Referenz 19.11.0.0 Copyright © 1996-2019 MVTec Software GmbH