HSL 2.0-Framework Beschreibung des Frameworks

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

Alle Methoden des Intervall-Objekts. Mehr ...

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

## Ausführliche Beschreibung

Alle Methoden des Intervall-Objekts.

Ein Beispiel für die Umsetzung eines Intervall-Timers liegt bei: 10709_MyIntervaltimer.py
Wird eine 1 auf Eingang 1 gesendet, wird ein Intervall-Timer erzeugt und gestartet, der in einem Intervall, dessen Länge (in Sekunden) über Eingang 2 bestimmt wird, auslöst und einen Ausgang mit dem Wert '1' beschreibt.
Durch Senden einer '0' an Eingang 1 kann der Timer gestoppt werden.

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.Interval.__init__ | ( |  | self,
|  |  | framework
| ) |  |

Konstruktor.

Warnung
  Diese Klasse sollte nicht direkt instanziert werden.

## Dokumentation der Elementfunktionen

## ◆ set_interval()

def hsl20_4_timer.hsl20_4_timer.Interval.set_interval | ( |  | self,
|  |  | time,
|  |  | callback,
|  |  | arguments = `()`
| ) |  |

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

Zu beachten
  Sollte zum Ausführungszeitpunkt eines Intervall-Timers (also am Ende eines Intervalls) die am Ende des vorausgehenden Intervalls ausgelöste Aktion noch nicht beendet sein, wird der neue Vorgang übersprungen!

Parameter

  time | int Zeit in ms
  callback | Nach Ablauf von time wird die Callback-Methode aufgerufen.
  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 Intervall-Timer bereits läuft, wird eine RuntimeError-Exception ausgelöst.

## ◆ start()

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

Startet den Intervall-Timer.

Das Callback wird zum ersten Mal nach der in der Methode set_interval definierten Zeit aufgerufen.

Zu beachten
  Sollte der Intervall-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.Interval.stop | ( |  | self | ) |

Hält den Intervall-Timer an.

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

- hsl20_4_timer.py