HSL 2.0-Framework Beschreibung des Frameworks

Öffentliche Methoden | Aufstellung aller Elemente
hsl20_4_timer.hsl20_4_timer.Timer Klassenreferenz

Alle Methoden des Timer-Objekts. Mehr ...

## Öffentliche Methoden
def | __init__ (self, framework)
| Konstruktor. Mehr ...
def | set_timer (self, timeout, callback, arguments=())
| Setzt die Zeit und die Callback-Methode, die nach Start des Timers aufgerufen werden soll. Mehr ...
def | stop (self)
| Hält den Timer an. Mehr ...
def | start (self)
| Startet den Timer. Mehr ...

## Ausführliche Beschreibung

Alle Methoden des Timer-Objekts.

Ein Beispiel für die Umsetzung eines Timers liegt bei: 10708_MyTimer.py
Der Beispiel-Code erstellt beim ersten Eingangstelegramm an Eingang 1 oder 2 einen Timer und startet ihn. Bei jedem weiteren Telegramm wird der Timer erneut gestartet.
Somit löst der Timer erst aus, wenn innerhalb von der an Eingang 3 definierten Zeit kein weiteres Telegramm am Eingang eintrifft. Wird auf Eingang 4 eine 1 gesendet, wird ein laufender Timer gestoppt.

Zu beachten
  Die Ausführungszeit kann von der definierten Zeit abweichen.
  Die Klasse arbeitet asynchron. Keine der angebotenen Methoden blockiert.

## Beschreibung der Konstruktoren und Destruktoren

## ◆ __init__()

def hsl20_4_timer.hsl20_4_timer.Timer.__init__ | ( |  | self,
|  |  | framework
| ) |  |

Konstruktor.

Warnung
  Diese Klasse sollte nicht direkt instanziert werden.

## Dokumentation der Elementfunktionen

## ◆ set_timer()

def hsl20_4_timer.hsl20_4_timer.Timer.set_timer | ( |  | self,
|  |  | timeout,
|  |  | callback,
|  |  | arguments = `()`
| ) |  |

Setzt die Zeit und die Callback-Methode, die nach Start des Timers aufgerufen werden soll.

Parameter

  timeout | int Zeit in ms
  callback | function Callback
  arguments | tuple Optional. Die Elemente des Tupels werden der Callback-Methode beim Aufruf als Parameter übergeben.

Ausnahmebehandlung

  RuntimeError | Wird diese Methode aufgerufen während der Timer bereits läuft, wird eine RuntimeError-Exception ausgelöst.

## ◆ start()

def hsl20_4_timer.hsl20_4_timer.Timer.start | ( |  | self | ) |

Startet den Timer.

Zu beachten
  Sollte der Timer bereits laufen, wird er angehalten und neu gestartet.

Ausnahmebehandlung

  AttributeError | Wird ausgelöst, wenn noch kein Callback oder kein Timeout definiert wurde.

## ◆ stop()

def hsl20_4_timer.hsl20_4_timer.Timer.stop | ( |  | self | ) |

Hält den Timer an.

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

- hsl20_4_timer.py