Bevor Sie diesen Abschnitt lesen machen Sie sich mit folgenden Konzepten vertraut:
- Statusabhängige Methoden
- Asynchrone Methoden
- Schnittstelle IACComponentTaskExec
- Physikalisches Modell aus Sicht des Anwenders.
PAProcessFunction ist eine abstrakte Klasse. Sie müssen sie ableiten, um sie verwenden zu können. PAProcessFunction ist so programmiert, dass Sie überwiegend aus virtuellen Methoden und Eigenschaften besteht, die bei Bedarf überschrieben werden können, um das Standardverhalten zu verändern. Einige davon müssen allerdings überschrieben werden. Welche das sind, wird weiter unten anhand des Beispielcodes erklärt.
Statusmethoden
Für jeden ACStateEnum-Wert, den die ACState-Eigenschaft annehmen, kann gibt es eine entsprechende Statusmethode:
public virtual void SMStarting()
public virtual void SMRunning()
public virtual void SMCompleted()
public virtual void SMResetting()
public virtual void SMPausing()
public virtual void SMPaused()
public virtual void SMResuming()
public virtual void SMHolding()
public virtual void SMHeld()
public virtual void SMRestarting()
public virtual void SMAborting()
public virtual void SMAborted()
public virtual void SMStopping()
public virtual void SMStopped()
Diese virtuellen Methoden werden entweder bei Statusänderung aufgerufen oder zyklisch in Zeitabständen von einer Sekunde. Der zyklische Aufruf wird aktiviert durch den Aufruf der Methode "PABase.SubscribeToProjectWorkCycle()" und deaktiviert durch den die Methode "PABase.UnSubscribeToProjectWorkCycle()". PAProcessFunction verwendet diese Methoden, falls ein Fehler aufgetreten ist, damit in zyklischen Zeitabständen geprüft wird, ob der Fehlerzustand in der Zwischenzeit behoben wurde. Danach wird UnSubscribeToProjectWorkCycle() aufgerufen, damit der Prozessor nicht unnötig belastet wird, wenn es nichts zu tun gibt. Falls Sie in Ihrer Ableitung solche Fehlerzustände in zyklischen Zeitabständen überwachen möchten, dann verwenden Sie ebenfalls diese zwei Methoden. Die zyklischen Aufrufe führt die Klasse PABase in der Methode DoWork() durch. Sie liest die ACState-Variable und schaut in der Methodenliste nach, ob es eine Methode mit dem gleichen Namen gibt. Wurde die Methode gefunden, dann wird diese aufgerufen. In der Methodenliste werden nur die Methoden aufgelistet, die mit der Attributklasse ACMethodState versehen wurden und die Eigenschaft IsPeriodic auf true gesetzt ist. Dies ist bei den oben aufgezählen Methoden der Fall. Beispiel:
[ACMethodState("en{'Starting'}de{'Startend'}", 20, true)]
public virtual void SMStarting()
Transitions-Methoden
Zustandswechsel erfolgen durch sogenannte "Transitionen", die entweder automatisch im Hintergrund ausgeführt werden oder durch UI-Interaktion, indem der Anwender eine der Transitions-Methoden aufruft:
public virtual void Pause()
public virtual void Resume()
public virtual void Hold()
public virtual void Restart()
public virtual void Abort()
public virtual void Stopp()
public virtual void Reset()
[ACMethodAsync("Process", "en{'Start'}de{'Start'}", (short)MISort.Start, false)]
public virtual ACMethodEventArgs Start(ACMethod acMethod)
Die Start-Methode unterscheidet sich gegenüber den anderen Transitions-Methoden darin, dass sie eine asynchrone Methode ist, um die Prozessfunktion überhaupt zu starten.
Der Aufruf von Transitionsmethoden ist durch die entsprechende IsEnabled-Methode abgesichert, damit nicht ungültige Zustandsübergänge stattfinden. Welche Zustandsübergänge erlaubt sind, wird mittels Zustandsübergangstabellen definiert. Die Zustandsübergangstabelle für ACState ist in der abstrakten Basisklasse gip.core.autocomponent.PAFuncStateConvBase implementiert.
Zustandsübergangstabelle PAFuncStateConvBase
In PAFuncStateConvBase sind zwei statische Methoden definiert, mit denen die Standard-Zustandsübergangstabelle abgefragt werden kann:
public static ACStateEnum GetDefaultNextACState(ACStateEnum acState, string transitionMethod = "")
public static bool IsEnabledTransitionDefault(ACStateEnum acState, string transitionMethod, PAProcessFunction paProcessFunction)
GetDefaultNextACState() gibt den nächsten Folgezustand, in Abhängigkeit des im Parameter "acState" übergebenen aktuellen Zustands, zurück. Der zweite optionale Parameter gibt an welche Transistion bzw. Transitionsmethode aufgerufen wird. Die Namen der Transistionsmethoden sind in den Konstanten der statischen Klasse ACStateConst deklariert:
ACStateConst.TMStart, ACStateConst.TMRun, ACStateConst.TMPause, ACStateConst.TMResume, ACStateConst.TMHold, ACStateConst.TMRestart, ACStateConst.TMAbort, ACStateConst.TMStopp, ACStateConst.TMReset
Wenn der Parameter "transitionMethod" leer gelassen wird, gibt den Standrad-Folgezustand zurück. Andernfalls der Folgezustand der eintreten wird, wenn die entsprechende Transitionsmethode aufgerufen wird.
Welche Transintionsmethode in einem bestimmten Zustand überhaupt aufgerufen werden darf gibt die Methode "IsEnabledTransistionDefault()" zurück.
Individuelle Zustandsübergangstabelle
Wenn Sie einen abweichenden Zustandsautomaten programmieren möchten oder Sie ein externes System angebunden haben (z.B. über eine SPS- oder OPC-Verbindung) das andere Variablen verwendet, mit dem ein anderer Zustandsautomat implementiert ist und dieser in den iPlus-Zustandsautomaten überführt werden muss, dann leiten Sie die PAFuncStateConvBase-Klasse ab und fügen Sie Ihre Klasse als Kind-Komponente der PAProcessFunction hinzu. Es müssen folgende Methoden in Ihrer "Konverterklasse" implementiert werden:
public abstract ACStateEnum GetNextACState(PAProcessFunction sender, string transitionMethod = "");
public abstract bool IsEnabledTransition(PAProcessFunction sender, string transitionMethod);
public abstract MsgWithDetails SendACMethod(PAProcessFunction sender, ACMethod acMethod);
public abstract PAProcessFunction.CompleteResult ReceiveACMethodResult(PAProcessFunction sender, ACMethod acMethod, out MsgWithDetails msg);
Eine Prozessfunktion ruft anstatt der statischen Methode "GetDefaultNextACState" die von Ihnen implementierte Instanzmethode "GetNextACState()" auf und anstatt der statischen Methode "IsEnabledTransistionDefault()" die Instanzmethode "IsEnabledTransition()".
Im Zustand SMStarting ruft die Basisimplementierung die Methode "SendACMethod()" auf damit die Parameter an das externe System versendet werden. Im Zustand SMCompleted wird dagegen "ReceiveACMethodResult()" aufgerufen, um das Ergebnis vom externen System abzufragen. Diese beiden Methoden müssen Sie in Ihrer Konverterklasse ebenfalls ausprogrammieren.
Konverterklassen haben in der Regel noch weitere netzwerkfähige Zieleingenschaften deklariert, die wiederum per Eigenschaftsbindung an Quelleigenschaften von Kommunikationstreiber-Klassen gebunden sind. Diese Eigenschaften geben im Grunde genommen den "Zustandsautomaten ihres eigenen Standards" wider. Programmieren Sie Ihre Konverterklasse Ereignisorientiert, so dass Sie auf Änderungsereignisse dieser Eigenschaften reagieren und diese in den ACState-Zustandsautomaten überführen und direkt die CurrentACState-Eigenschaft der Elternprozessfunktion (ParentACComponent) setzen.
Beispiel
Folgender Programmcode wurde dem Beispielprojekt entnommen, das Sie auf der Startseite herunterladen können, um die Schritte nachvollziehen zu können wie man eine eigene Prozessfunktion implementiert:
- Leiten Sie von PAProcessFunction ab. Die ACClassInfo-Attributklasse muss folgendermaßen konstruiert werden:
- Verwenden Sie "Global.ACKinds.TPAProcessFunction" um iPlus bekannt zugeben, dass es um eine Prozessfunktion handelt.
- "Global.ACStorableTypes.Required" muss verwendet werden, weil z.B. die ACState-Eigenschaft persistierbar ist und der Zustand beim Neustart des Dienstes wiederhergestellt werden muss.
- Referenzieren Sie die zugehörige Workflowklasse, die mit dieser Prozessfunktion kompatibel ist. In diesem Beispiel ist das "PWOrder.PWClassName" die Sie als Beispiel im nachfolgenden Kapitel (PWNodeProcessMethod) kennen lernen werden.
- Deklarieren Sie Parameter- und Rückgabeliste der virtuellen Methode (ACMethod), die beim asynchronen Aufruf der Start-Methode übergeben wird. Zum Schluss generieren Sie eine Instanz von ACMethodWrapper, um die virtuelle Methode der iPlus-Runtime bekannt zu geben, indem Sie "RegisterVirtualMethod()" aufrufen.
- Deklarieren einen Execute-Helper für die statischen Aufrufe, indem Sie den statischen Execute-Handler als Delegat der RegisterExecuteHandler()-Methode übergeben.
- Überschreiben Sie die Start-Methode und veröffentlichen Sie sie, indem Sie ACMethodAsync-Attribuklasse verwenden.
- Ab diesem Moment ist eine Prozessfunktion vollständig programmiert und kann in der iPlus-Entwicklungsumgebung verwendet werden. Jedoch fehlt noch der eigentliche Programmcode für das, was die Funktion eigentlich machen soll. Deshalb ist diesem Code-Beispiel die SMRunning-Methode überschrieben worden und aus Demonstrationszwecken wartet sie drei zyklische Aufrufe ab, weil sie zuerst mit "SubscribeToProjectWorkCycle" aktiviert worden ist und danach die zyklische Abarbeitung mit "UnSubscribeToProjectWorkCycle" deaktiviert wird.
- In diesem Schritt wird die eigentliche Funktionalität programmiert. In diesem Beispiel ist der eigentliche Zweck "Auftragsdaten" in eine Datei zu schreiben die vom asynchronen Aufrufer (Workflowklasse) im Parameter "Content" übergeben worden sind. Weil das Schreiben einer Datei eine längere Zeit in Anspruch nehmen könnte, wird dieser Schreibvorgang an die DelegateQueue der Wurzel-ACComponent (Applicationmanager) übergeben. Damit ist der aufrufende Thread (zyklische Abarbeitung) nicht blockiert und andere Funktionen werden anschließend sofort bedient.
- Im letzten Schritt bringen Sie den Zustandsautomaten in den "SMCompleted"-Zustand. Wenn die Hilfseigenschaft ACStateConverter nicht "null" ist, dann haben Sie eine eigene Konverterklasse im Anwendungsbaum als Kindinstanz hinzugefügt. In diesem Fall entscheidet Ihre Konverterklasse darüber was der Folgezustand sein wird - diese könnte unter Umständen auch ein andere Zustand als "SMCompleted" sein. Wenn die Hilfseigenschaft ACStateConverter "null" ist, wird die Standardimplementierung verwendet und SMCompleted zurückgegeben.
Zum Abschluss noch ein wichtiger Hinweis: Überschreiben Sie immer die "SMIdle()"-Methode, um ihre privaten Feldwerte zurückzusetzen. Im SMIdle-Zustand muss eine Funktion immer in den Grundzustand gebracht werden - so wie sie initial bei der Generierung ursprünglich im Heap angelegt worden ist!
