API Konventionen

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

Benennungskonventionen

• 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 die Benennung IsXxx(), HasXxx() oder CanXxx().
• Erstellen/Hinzufügen/Entfernen: Fabrik- und Sammlungsmethoden folgen den Mustern CreateXxx(), AddXxx(), RemoveXxx().

Typkonventionen

• Rückgabetypen und Parametertypen verweisen, wo möglich, auf Klassen innerhalb der API.
• Primitive Typen (str, int, float, bool) folgen den Standardkonventionen von Python.
• Enum-ähnliche Typen können als Ganzzahlkonstanten oder als spezielle Enum-Klassen auftreten.

Gängige Muster

• Operator-Muster: Viele Arbeitsabläufe beinhalten das Erstellen oder Beschaffen eines Operator-Objekts, dessen Konfiguration und anschließende Ausführung.
• Ereignismuster: Ereignisse werden über Methoden zur Registrierung von Ereignishandlern abonniert und lösen Rückrufe mit Kontextobjekten aus.
• Download-/Upload-Muster: Der Datentransfer erfolgt gemäß einer profilbasierten Konfiguration, gefolgt von der Ausführung über eine Operator-Klasse.

Paketstruktur

Der API umfasst die folgenden Pakete:

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