API Konventionen

Diese Seite beschreibt die Konventionen, die im gesamten FASTSUITE E2 Python API verwendet werden.

Namensmuster

• Get/Set Paare: Die meisten Eigenschaften werden über GetXxx() / SetXxx() Methodenpaare und nicht über Python-Eigenschaften bereitgestellt.
• Is/Has/Can-Präfixe: Boolesche Abfragen verwenden IsXxx(), HasXxx() oder CanXxx() Benennungen.
• Erstellen/Hinzufügen/Entfernen: Fabrik- und Sammelmethoden folgen CreateXxx(), AddXxx() RemoveXxx() Mustern.

Typkonventionen

• Rückgabe von Typen und Parametertypen, wo möglich, Referenzklassen innerhalb der API.
• Primitive Typen (str, int, float, bool) folgen den Standardkonventionen von Python.
• Enum-ähnliche Typen können als ganzzahlige Konstanten oder als dedizierte Enum-Klassen erscheinen.

Gemeinsame Muster

• Operator-Pattern: Viele Workflows beinhalten das Erstellen oder Erlangen eines Operator-Objekts, dessen Konfiguration und dann das Ausführen.
• Ereignismuster: Ereignisse werden über Eventhandler-Registrierungsmethoden abonniert und Callbacks mit Kontextobjekten gestartet.
• Download-/Upload-Muster: Die Datenübertragung erfolgt nach einer profilbasierten Konfiguration und wird dann über eine Operator-Klasse ausgeführt.

Paketstruktur

Die API umfasst folgende Pakete:

• cenpydownload
• cenpylib
• cenpymath
• cenpyolpcore
• cenpyunits
• cenpyupload