Isom.Sys.Events.Guard

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

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Sys.Events.Guard

Beschreibung

Ein Guard-Fachobjekt repräsentiert einen Wächter, der nicht mittels Annotationen, sondern mittels Funktionen konfiguriert, aktiviert und wieder deaktiviert wird.



Funktionen

Isom.Sys.Events.Guard.CreateGuard

Erzeugt einen benannten Wächter zur Überwachung einer Umgebungsgröße.

Isom.Sys.Events.Guard Isom.Sys.Events.Guard.CreateGuard  ( Isom.Base.String  name,
Isom.Base.String  observedVariable,
Isom.Base.String  condition,
Isom.Base.String  callback  )

Erzeugt einen benannten Wächter zur Überwachung einer Umgebungsgröße.

Die Größe wird regelmäßig abgefragt. Erfüllt der ermittelte Wert eine angegebene Bedingung, wie eine angegebene Rückruffunktion asynchron aufgerufen.

Ein Wächter, der mittels CreateGuard(String,String,String,String) erzeugt wurde, ist inaktiv. Zum Start der Überwachung muss Enable() aufgerufen werden.

Parameter:
name  Legt eine eindeutige Bezeichnung des Wächters fest. Anhand dieser Bezeichnung kann der Wächter mit der Funktion FindGuard(String) abgerufen werden.
observedVariable  Bezeichnung der Umgebungsvariable, die überwacht werden soll. Zulässige Werte sind: ISOM:BatteryVoltage, ISOM:IgnitionVoltage
condition  Logischer Ausdruck, bei dessen Auswertung zu 'true' für die Umgebungsvariable ein Rückruf ausgelöst wird. Zugelassen sind Vergleichsoperatoren (>=, ==, <=, >, <) sowie logische Verknüpfungen (NOT, AND, OR, XOR). Der linke Operand der Vergleichsoperatoren ist immer die gemessene Größe. Der Operatorvorrang ist: NOT, AND, OR
callback  Name der Rückruffunktion, die aufgerufen wird, wenn condition zu 'true' ausgewertet wird. Die Funktion muss im aktuellen Namensraum oder im Namensraum des OEM vorhanden sein. Ihre Signatur muss lauten: Boolean (GuardInfo)
Rückgabe:
Die Instanz des Wächters.
Ausnahmebehandlung:
Wenn name einen bereits existenten Wächter beschreibt
Wenn observedVariable eine nicht bekannte Umgebungsgröße bezeichnet
Wenn condition nicht interpretierbar ist.
    // Beispielcode zur Demonstration von CreateGuard(String, String, String, String), 
    // Enable(), Disable() 
    using Isom.Base.*; 
    using Isom.Sys.Events.*; 
    ... 
    Guard aTerminal30Guard = Guard.CreateGuard("terminal30Guard1", "ISOM:BatteryVoltage", "< 12.4 OR > 14.5", "OnTerminal30Guard"); 
    aTerminal30Guard.Enable(); 
    ... 
    aTerminal30Guard.Disable(); 
    ... 
    aTerminal30Guard.Enable(); 
    ... 
    aTerminal30Guard.Disable(); 
    aTerminal30Guard.Dispose(); 

Isom.Sys.Events.Guard.Disable

Beendet die Überwachung durch einen Wächter.

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

Beendet die Überwachung durch einen Wächter.

Rückgabe:
'true', falls die Überwachung erfolgreich deaktiviert wurde.
Ausnahmebehandlung:
wenn der Wächter bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.Guard.Dispose

Gibt ein Wächterobjekt frei.

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

Gibt ein Wächterobjekt frei.

Der Wächter ist nach diesem Aufruf nicht mehr nutzbar und wird nicht mehr durch FindGuard(String) gefunden.

Rückgabe:
'true'
Ausnahmebehandlung:
wenn der Wächter bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.Guard.Enable

Startet die Überwachung, die für einen Wächter definiert wurde.

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

Startet die Überwachung, die für einen Wächter definiert wurde.

Rückgabe:
'true', falls die Überwachung erfolgreich gestartet wurde.
Ausnahmebehandlung:
wenn der Wächter bereits mit Dispose() freigegeben wurde
Isom.Sys.Events.Guard.FindGuard

Sucht einen bereits durch Guard.CreateGuard(String,String,String,String) erzeugten und benannten Wächter.

Isom.Sys.Events.Guard Isom.Sys.Events.Guard.FindGuard  ( Isom.Base.String  name  ) 

Sucht einen bereits durch Guard.CreateGuard(String,String,String,String) erzeugten und benannten Wächter.

Parameter:
name  Bezeichnung des Wächters.
Rückgabe:
Der mit name bezeichneten Wächter.
Ausnahmebehandlung:
Wenn name keinen bereits existierenden benannten Wächter bezeichnet.
    // Beispielcode zur Verwendung von FindGuard(String); siehe dazu auch das 
    // Codebeispiel zu CreateGuard(String, String) 
    using Isom.Base.*; 
    using Isom.Sys.Events.*; 
    ... 
    Guard aTerminal30Guard = Guard.FindGuard("terminal30Guard1"); 

Isom.Sys.Events.Guard.GetName

Ruft die Bezeichnung des benannten Wächters ab.

objectbound Isom.Base.String Isom.Sys.Events.Guard.GetName  (  ) 

Ruft die Bezeichnung des benannten Wächters ab.

Rückgabe:
Die Bezeichnung des benannten Wächters.
Isom.Sys.Events.Guard.GetObservedVariable

Ruft die Bezeichnung der von diesem Wächter überwachten Umgebungsvariable ab.

objectbound Isom.Base.String Isom.Sys.Events.Guard.GetObservedVariable  (  ) 

Ruft die Bezeichnung der von diesem Wächter überwachten Umgebungsvariable ab.

Rückgabe:
Die Bezeichnung der überwachten Umgebungsvariable
Isom.Sys.Events.Guard.GetPeriod

Ruft die Zeitspanne zwischen 2 Überprüfungen der zu überwachenden Umgebungsgröße ab.

objectbound Isom.Base.Number Isom.Sys.Events.Guard.GetPeriod  (  ) 

Ruft die Zeitspanne zwischen 2 Überprüfungen der zu überwachenden Umgebungsgröße ab.

Rückgabe:
Zeitspanne zwischen 2 Überprüfungen der zu überwachenden Umgebungsgröße in Millisekunden
Isom.Sys.Events.Guard.IsVoid

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

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

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

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

Ändert die Zeitspanne zwischen 2 Überprüfungen der zu überwachenden Umgebungsgröße.

objectbound Isom.Base.Boolean Isom.Sys.Events.Guard.SetPeriod  ( Isom.Base.Number  milliSeconds  ) 

Ändert die Zeitspanne zwischen 2 Überprüfungen der zu überwachenden Umgebungsgröße.

Die Voreinstellung beträgt 5 Sekunden. Die Zeitspanne kann unabhängig davon geändert werden, ob der Wächter aktiv oder inaktiv ist.

Parameter:
milliSeconds  Zeitspanne zwischen 2 Überprüfungen der zu überwachenden Umgebungsgröße
Rückgabe:
'true', wenn die Zeitspanne erfolgreich geändert wurde
Ausnahmebehandlung:
wenn der Wächter bereits mit Dispose() freigegeben wurde
wenn die angegebene Zeitspanne kleiner als 0 ist
Isom.Sys.Events.Guard.Void

Erzeugt ein ungültiges Objekt.

Isom.Sys.Events.Guard Isom.Sys.Events.Guard.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