Isom.Sys.Events.Timer

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Sys.Events.Timer

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Sys.Events.Timer

Beschreibung

Isom.Sys.Events.Timer ist ein Fachobjekt für einen einmal auslösenden Zeitgeber ("Wecker").



Funktionen

Isom.Sys.Events.Timer.CreateTimer

Erzeugt einen benannten Zeitgeber, der einmalig auslöst, wenn eine vorgegebene Zeitspanne verstrichen ist.

Isom.Sys.Events.Timer Isom.Sys.Events.Timer.CreateTimer  ( Isom.Base.String  name,
Isom.Base.Number  milliSeconds,
Isom.Base.String  callback  )

Erzeugt einen benannten Zeitgeber, der einmalig auslöst, wenn eine vorgegebene Zeitspanne verstrichen ist.

Dann wird die angegebene Rückruffunktion asynchron aufgerufen.

Ein Zeitgeber, der mittels CreateTimer(String,Number,String) erzeugt wurde, ist inaktiv. Zum Start der Zeitmessung muss Enable() aufgerufen werden.

Parameter:
name  Legt eine eindeutige Bezeichnung des Zeitgebers fest. Anhand dieser Bezeichnung kann der Zeitgeber mit der Funktion FindTimer(String) abgerufen werden.
milliSeconds  Dauer bis zum Auslösen des Zeitgebers in Millisekunden
callback  Name der Rückruffunktion, die aufgerufen wird, wenn die angegebene Zeitspanne verstrichen ist. Die Funktion muss im aktuellen Namensraum oder im Namensraum des OEM vorhanden sein. Ihre Signatur muss lauten: Boolean (TimerInfo)
Rückgabe:
Die Instanz des Zeitgebers.
Ausnahmebehandlung:
Wenn name einen bereits existenten einmal auslösenden Zeitgeber beschreibt
Wenn die angegebene Zeitspanne negativ ist
    // Beispielcode zur Demonstration von CreateTimer(String,Number,String), 
    // Enable(), Disable() 
    using Isom.Base.*; 
    using Isom.Sys.Events.*; 
    using Isom.Context.*; 

    Boolean FilterMyAction(TherapyPlanAction action) 
    { 
      Timer myTimer = Timer.CreateTimer("myFilterTimer", 10000, "OnLongFilterFunction"); 
      myTimer.Enable(); 
      ... 
      myTimer.Disable(); 
      myTimer.Dispose(); 
      return true; 
    } 

    // Wird aufgerufen, wenn FilterMyAction länger als 10 Sekunden dauert 
    Boolean OnLongFilterFunction(TimerInfo info) 
    { 
      // Die Ausführung der Filterfunktion dauert ungewöhnlich lang 
    } 

Isom.Sys.Events.Timer.Disable

Deaktiviert den Rückrufempfänger des Zeitgebers.

objectbound Isom.Base.Boolean Isom.Sys.Events.Timer.Disable  (  ) 

Deaktiviert den Rückrufempfänger des Zeitgebers.

Rückgabe:
'true', falls der Rückrufempfänger erfolgreich deaktiviert wurde.
Ausnahmebehandlung:
wenn der Zeitgeber bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.Timer.Dispose

Gibt ein Zeitgeberobjekt frei.

objectbound Isom.Base.Boolean Isom.Sys.Events.Timer.Dispose  (  ) 

Gibt ein Zeitgeberobjekt frei.

Der Zeitgeber ist nach diesem Aufruf nicht mehr nutzbar und wird nicht mehr durch FindTimer(String) gefunden.

Rückgabe:
'true'
Ausnahmebehandlung:
wenn der Zeitgeber bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.Timer.Enable

Aktiviert den Zeitgeber und den Rückrufempfänger dieses Zeitgebers.

objectbound Isom.Base.Boolean Isom.Sys.Events.Timer.Enable  (  ) 

Aktiviert den Zeitgeber und den Rückrufempfänger dieses Zeitgebers.

Die Zeitmessung beginnt, wenn Enable() aufgerufen wird, während der Zeitgeber deaktiviert ist. Die Zeitmessung kann nicht durch eine Folge von Disable() und Enable() pausiert werden. Ein einmal abgelaufener Zeitgeber kann nicht erneut durch Disable() und Enable() benutzt werden.

Rückgabe:
'true', falls der Zeitgeber und der Rückrufempfänger erfolgreich aktiviert wurden
Ausnahmebehandlung:
wenn der Zeitgeber bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.Timer.FindTimer

Sucht einen bereits durch Timer.CreateTimer(String,Number,String) erzeugten und benannten Zeitgeber.

Isom.Sys.Events.Timer Isom.Sys.Events.Timer.FindTimer  ( Isom.Base.String  name  ) 

Sucht einen bereits durch Timer.CreateTimer(String,Number,String) erzeugten und benannten Zeitgeber.

Parameter:
name  Bezeichnung des Zeitgebers.
Rückgabe:
Den mit name bezeichneten Zeitgeber.
Ausnahmebehandlung:
Wenn name keinen bereits existierenden benannten Zeitgeber bezeichnet.
    // Beispielcode zur Verwendung von FindTimer(String); siehe dazu auch das 
    // Codebeispiel zu CreateTimer(String,Number,String) 
    using Isom.Base.*; 
    using Isom.Sys.Events.*; 
    ... 
    Timer filterTimer = Timer.FindTimer("myFilterTimer"); 

Isom.Sys.Events.Timer.IsVoid

Bestimmt, ob es sich um das Void-Objekt handelt.

objectbound Isom.Base.Boolean Isom.Sys.Events.Timer.IsVoid  (  ) 

Bestimmt, ob es sich um das Void-Objekt handelt.

Rückgabe:
'true', falls dies das Void-Objekt ist, 'false' sonst.
Isom.Sys.Events.Timer.Void

Erzeugt ein ungültiges Objekt.

Isom.Sys.Events.Timer Isom.Sys.Events.Timer.Void  (  ) 

Erzeugt ein ungültiges Objekt.

Die Funktion kann in Fehlerfällen verwendet werden, um z.B. einen ungültigen Funktionsrückgabewert zu erzeugen.

Rückgabe:
Ungültiges Objekt.

Version 9.10.1.0 vom 25 November 2013