HSL 2.0-Framework
1.9
Beschreibung des Frameworks
|
Basis-Klasse für einen HSL 2.0-Baustein. Mehr ...
Öffentliche Methoden | |
def | __init__ (self, homeserver_context, module_context) |
Konstruktur, muss im Konstruktor der vererbten Klasse aufgerufen werden. Mehr ... | |
def | on_input_value (self, index, value) |
Wird jedes Mal aufgerufen, wenn ein Wert auf einem Eingang des Baustein eintrifft. Mehr ... | |
def | on_init (self) |
Wird einmalig aufgerufen, wenn der Baustein initialisiert wird. Mehr ... | |
Private Methoden | |
def | _get_module_id (self) |
Liefert die Laufzeit-ID des Moduls zurück. Mehr ... | |
def | _get_module_class_id (self) |
Liefert die fünfstellige Baustein-ID (zum Beispiel '10001') zurück. Mehr ... | |
def | _get_framework (self) |
Liefert ein Objekt vom Typ hsl20_2.Framework zurück. Mehr ... | |
def | _get_logger (self, logType, param) |
Liefert ein Objekt vom Type hsl20_2.Logger zruück. Mehr ... | |
def | _get_input_value (self, index) |
Liefert den Wert, der zum Zeitpunkt des Aufrufs am Eingang index anliegt, zurück. Mehr ... | |
def | _set_output_value (self, index, value) |
Setzt einen Wert auf einen Ausgang. Mehr ... | |
def | _can_set_output (self) |
Zeigt an, ob ein Wert auf einen Ausgang gesetzt werden kann. Mehr ... | |
def | _get_remanent (self, index) |
Liefert den Wert der remanenten Variable zurück. Mehr ... | |
def | _set_remanent (self, index, value) |
Beschreibt eine remanente Variable. Mehr ... | |
Basis-Klasse für einen HSL 2.0-Baustein.
Ein HSL 2.0-Baustein muss diese Klasse durch Vererbung als Basis haben. Der Generator erzeugt die notwendigen Code-Segmente: Ein Beispiel für die Umsetzung des Bausteins Sperre liegt bei: 10701_hsl20_2_BaseModule_03.py
def hsl20_2.hsl20_2.BaseModule.__init__ | ( | self, | |
homeserver_context, | |||
module_context | |||
) |
Konstruktur, muss im Konstruktor der vererbten Klasse aufgerufen werden.
homeserver_context | object Verweis auf die HomeServer-Objektstruktur. |
module_context | string Schlüssel des Modulkontexts. Der Schlüssel legt fest, in welchem Kontext der Baustein läuft. |
|
private |
Zeigt an, ob ein Wert auf einen Ausgang gesetzt werden kann.
Liefert False falls vorerst kein weiterer Wert geschrieben werden kann.
|
private |
Liefert ein Objekt vom Typ hsl20_2.Framework zurück.
|
private |
Liefert den Wert, der zum Zeitpunkt des Aufrufs am Eingang
index anliegt, zurück.
Der am Eingang anliegende Wert kann sich während des Ablaufs der Bausteinlogik ändern.
index | int Index des Eingangs. |
|
private |
Liefert ein Objekt vom Type hsl20_2.Logger zruück.
logType | int Logging-Handler (z.B. hsl20_2.LOGGING_SYSLOG) |
param | tuple Parameter zum verwendeten Logging-Handler |
|
private |
Liefert die fünfstellige Baustein-ID (zum Beispiel '10001') zurück.
|
private |
Liefert die Laufzeit-ID des Moduls zurück.
Die ID ist nur während der Laufzeit des Geräts gültig.
|
private |
Liefert den Wert der remanenten Variable zurück.
Siehe auch Remanentspeicher
index | int Index der remanten Variable |
|
private |
Setzt einen Wert auf einen Ausgang.
index | int Index des Ausgangs, der beschrieben werden soll. |
value | float/str Wert, der auf den Ausgang geschrieben wird. Der Datentyp ist abhängig davon, ob der Ausgang als numerisch oder alphanumerisch definiert wurde. |
|
private |
Beschreibt eine remanente Variable.
Siehe auch Remanentspeicher
index | int Index der remanenten Variable |
value | float/str Wert der remanenten Variable (maximale Größe: 30.000 Byte). |
def hsl20_2.hsl20_2.BaseModule.on_init | ( | self | ) |
Wird einmalig aufgerufen, wenn der Baustein initialisiert wird.
Diese Methode kann implementiert (überschrieben) werden, wenn ein Baustein erstellt wird.
def hsl20_2.hsl20_2.BaseModule.on_input_value | ( | self, | |
index, | |||
value | |||
) |
Wird jedes Mal aufgerufen, wenn ein Wert auf einem Eingang des Baustein eintrifft.
Die Methode wird für jedes Eintreffen eines Wertes an einem Eingang genau einmal aufgerufen.
Diese Methode muss implementiert (überschrieben) werden, wenn ein Baustein erstellt wird.
index | int Index des Eingangs. |
value | float/str Wert, der auf dem Eingang eingetroffen ist. Der Datentyp ist abhängig davon, ob der Eingang als numerisch oder alphanumerisch definiert wurde. |