Bricht eine Aktionsplanausführung ab.

Diese Funktion bewirkt, dass eine Aktionsplanausführung vorzeitig abgebrochen wird. Dabei wird versucht, alle Ausführungsfäden des Aktionsplans geordnet zu beenden. Die für dieses geordnete Beenden zur Verfügung stehende Zeitspanne wird als Parameter angegeben. Können die Ausführungsfäden in dieser Zeit angehalten werden, kehrt die Funktion mit 'true' zurück. In diesem Fall kann nach Rückkehr der Funktion die Sitzung fortgeführt werden. Können die Ausführungsfäden in dieser Zeit nicht angehalten werden, kann die Konsistenz des ISOM-Datenmodells nicht mehr gewährleistet werden. Daher geht ISOM dann in den Zustand über, der auch mit Aufruf von Isom.Context.ContextConfiguration.FinalizeSession() erreicht wird. Danach lässt sich die Sitzung nur noch beenden.

Bemerkungen:

Wird diese Funktion als Teil einer Aktionsplanausführung aufgerufen, kehrt der Aufruf nicht zurück, da das aufrufende Programm nach Ausführung der Funktion beendet wird.

Wird diese Funktion aufgerufen, während kein Aktionsplan ausgeführt wird, kehrt der Aufruf mit 'false' zurück.

      Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
      Isom.Plan.ActionPlan ap = Isom.Plan.ActionPlan.GetInstance(tp); 
      ap.Cancel(10000); 

Parameter:

timeout

Zeitspanne, in der der Aktionsplan abgebrochen werden soll

Rückgabe:

Isom.Base.Boolean
'true', falls die Aktionsplanausführung geordnet abgebrochen wurde. 'false' sonst.

Datum:

letzte Änderung am 21.09.2010

Erzeugt eine identische Kopie des Objekts.

Rückgabe:

Das geklonte Objekt.

Ermittelt ob der Aktionsplans asynchrone Aktionen enthält.

Es wird geprüft, ob der Aktionsplans asynchrone Aktionen enthält. Der Ausführungszustand der Aktionen wird nicht berücksichtigt.

Rückgabe:

'true', wenn der Aktionsplan mindestens eine asynchrone Aktion enthält, sonst 'false'.

Löscht eine persistierte Sitzung.

Vorbedingung:

Es existiert eine konservierte Sitzung (d.h. PreservedSessionExists() liefert 'true')

Rückgabe:

'true' wenn die konservierte Sitzung gelöscht werden konnte.

Ermittelt zum aktuellen Therapieplan den zugehörigen Aktionsplan und setz diesen als aktuellen Aktionsplan.

Für Top-Level-Aufrufe sollte stattdessen die verschattete Funktion Isom.Global.Processes.DoTp2Ap() verwendet werden.

  Boolean main() 
  { 
      // ... 
      Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
      Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 

      ap.DoTp2Ap(); 
      ap.ExecuteActionPlan(); 
      // ... 
  } 

Rückgabe:

'true', falls ein ausführbarer Aktionsplan erfolgreich ermittelt wurde, 'false' sonst.

Siehe auch:

Isom.Global.Processes.DoTp2Ap() für den Einsprungspunkt, der diese Funktion typischerweise verwendet.

Startet die Ausführung des Aktionsplans.

Für Top-Level-Aufrufe sollte stattdessen die verschattete Funktion Isom.Global.Processes.ExecuteActionPlan() verwendet werden.

Rückgabe:

'true', falls alle Aktionen im Aktionsplan erfolgreich ausgeführt wurden, 'false' sonst.

Siehe auch:

Isom.Global.Processes.ExecuteActionPlan() für den Einsprungspunkt, der diese Funktion typischerweise verwendet.

Liefert die Namen aller Eigenschaften des Aktionsplans.

Veraltet:

Wird seit Version 6.5.0.0 nur noch aus Kompatibilitätsgründen unterstützt. Der Abruf der Eigenschaftsnamen wird seitdem durch die Funktion Isom.Context.Ecu.GetPropertyNames() bereitgestellt.

  Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
  Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 
  Isom.Base.StringList allPropNames = ap.GetAllPropertyNames(); 
  allPropNames.Reset(); 
  while( allPropNames.HasNext() ) 
  { 
      Isom.Base.String propName = allPropNames.Next(); 
      Isom.Base.String propVal  = ap.GetProp(propName); 
      // ... 
  } 

Rückgabe:

Liste aller Eigenschaftsnamen des Aktionsplans.

Liefert den N-Kanal, über den die aufrufende Aktion durchgeführt wird.

  Isom.Base.String channel = Isom.Plan.ActionPlan.GetCurrentActionChannel(); 

Rückgabe:

N-Kanal, über den die aufrufende Aktion durchgeführt wird Statische Funktion.

Ermittelt die prognostizierte Gesamtausführungszeit.

Rückgabe:

Die prognostizierte Gesamtausführungszeit in Sekunden.

Ermittelt den für diese ISOM-Sitzung gültigen Aktionsplan.

  Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
  Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 

Rückgabe:

Der für diese ISOM-Sitzung singuläre Aktionsplan.

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls die Funktion in einer Phase des Phasenmodells aufgerufen wird, in der noch kein Aktionsplan existiert.

Ermittelt für den angegebenen Phasenbezeichner die zugehörige Aktionsplanphase.

  Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
  Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 
  Isom.Plan.ActionPlanPhase ap1 = ap.GetPhase( "1" ); 

Rückgabe:

Aktionsplanphase oder Void-Objekt, falls es für diesen Phasenbezeichner keine Aktionsplanphase gibt.

Ermittelt Liste von Phasenbezeichnern.

Mit Hilfe dieser Phasenbezeichner kann über die Funktion 'GetPhase' auf die entsprechende Phase zugegriffen werden. Der Bezeichner ist der Index der Phase und damit eine Ganzzahl von 1 bis einschließlich Phases.Count (Anzahl der vorhandenen Phasen)

Zu beachten:

Phasen, die ausschließlich Aktionen im Zustand 'Rescheduled' beinhalten, werden im Normalfall ausgeblendet. Dies kann Autoren-seitig durch folgenden Konfigurationscode vermieden werden: Isom.Context.ContextConfiguration.SetProp("ActionPlan.Iterators.SuppressRescheduledActions","false")

  Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
  Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 
  Isom.Base.StringList phaseIDs = ap.GetPhases(); 

Rückgabe:

Liste von Phasenbezeichnern.

Gibt die Versionskennung einer existierenden konservierten Sitzung zurück.

Vorbedingung:

Es existiert eine konservierte Sitzung (d.h. PreservedSessionExists() liefert 'true')

Rückgabe:

Die Versionskennung der konservierten Sitzung, bzw. das Void-Objekt, falls keine konservierte Sitzung existiert.

Ermittelt die Gesamtausführungszeit des Aktionsplans.

Rückgabe:

Die tatsächliche Gesamtausführungszeit in Sekunden.

Ermittelt den Wert der vorgegebenen Eigenschaft (property) des Aktionsplans.

Die systemseitig ermittelten Eigenschaftsnamen sind in den herstellerspezifischen Begleitdokumenten zu finden.

  Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
  Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 
  Isom.Base.String val = ap.GetProp( "SomeOemSpecificName" ); 

Rückgabe:

Wert der Eigenschaft.

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls der Wert ungesetzt oder gleich "" ist.

Liefert die Namen aller technischen Eigenschaften für den AktionsPlan.

Es werden die Eigenschaftsnamen für die technischen Eigenschaften (siehe Isom.Plan.ActionPlan.GetProp()) zurückgeliefert. Die systemseitig ermittelten Eigenschaftsnamen sind in den herstellerspezifischen Begleitdokumenten zu finden.

  Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
  Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance(tp); 
   Isom.Base.StringList propertyNames = ap.GetPropNames(); 
   propertyNames.Reset(); 
   while(propertyNames.HasNext()) 
   { 
     //Abfrage des Werts für den gelieferten Eigenschaftsnamen und z. B. Aufzeichnung ins Protokoll 
   } 

Rückgabe:

Isom.Base.StringList
Liste der Namen aller technischen Eigenschaften für den AktionsPlan.

Siehe auch:

Isom.Plan.ActionPlan.GetProp()

Datum:

letzte Änderung am 09.09.2010

Prüft, ob der Aktionsplan neu gestartet (vs.

vollständig abgearbeitet) wurde.

Zu beachten:

Die Funktion ist primär für die Autorengesteuerte Maßnahmensteigerungsbehandlung sinnvoll.

Die Funktion sollte primär für die Schleife um ActionPlan.ExecuteActionPlan() in Global.Processes.ExecuteActionPlan() eingesetzt werden (s. Zusammenhängendes Beispiel für die Autorengesteuerte Maßnahmensteigerung).

  Boolean ExecuteActionPlan () 
  { 
      // ... 
      Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
      Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 

      while ( true ) // Autoren-gesteuerte äußere Maßnahmensteigerung 
      { 
          ap.ExecuteActionPlan (); 

          if( ap.IsActionPlanRestarting().Failed() ) 
          { 
              break; 
          } 

      } // while ( true ) // Autoren-gesteuerte äußere Maßnahmensteigerung 

      // ... 
 } 

Rückgabe:

'true' g.d.w. Aktionsplan neu startbar ist, d.h. ActionPlan.ExecuteActionPlan() neu aufrufbar ist; 'false' sonst.

Siehe auch:

Zusammenhängendes Beispiel für die Autorengesteuerte Maßnahmensteigerung für ein zusammenhängendes Beispiel.

Isom.Plan.ActionPlan.RestartActionPlan() für die Funktion zum Auslösen eines Neustarts.

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

Rückgabe:

'true', falls dies das Void-Objekt ist, 'false' sonst.

Die Funktion Pause hält die Ausführung des Aktionsplans zum nächst möglichen Zeitpunkt an.

Bereits laufende Aktionen werden zu Ende ausgeführt, aber es wird nicht mit der Ausführung weiterer Aktionen begonnen. Die Funktion kehrt erst zurück, wenn die Ausführung angehalten wurde oder der Versuch, die Ausführung anzuhalten, fehlgeschlagen ist.

Rückgabe:

'true' wenn die Aktionsplanausführung erfolgreich angehalten wurde und mit Resume() fortgesetzt werden kann.

'false' wenn die Aktionsplanausführung bereits angehalten war.

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls die Aktionsplanausführung nicht angehalten werden konnte, da die Funktionalität nicht zur Verfügung steht oder weil ein Fachdienstaufruf gescheitert ist. Dies ist auch der Fall, wenn der verwendete Fachdienst das Funktionsmerkmal nicht unterstützt.

Siehe auch:

Isom.Plan.ActionPlan.Resume() zum Fortsetzen einer unterbrochenen Sitzung.

Überprüft, ob eine konservierte Sitzung gefunden werden kann.

Rückgabe:

'true' wenn eine Sitzung gefunden wurde, 'false' sonst

Löst die Konservierung der aktuellen ISOM-Sitzung aus.

Dadurch wechselt ISOM in den Processing-State "Pause", in dem die ISOM-Sitzung beendet oder aus dem heraus die Sitzung fortgesetzt werden kann. Begonnene Aktionen werden noch zu Ende geführt.

  Boolean DoShowReassemblyMsgs (Isom.Plan.TherapyPlanAction action) 
  { 
      // ... 
      if (persist)    // "Konservieren" wurde gewählt 
      { 
           Isom.Plan.ActionPlan.PreserveSession(); 
      } 
  } 

Rückgabe:

immer 'true'

Initiiert die Neuausführung des Aktionsplans.

Achtung:

Die Funktion setzt im Wesentlichen nur ein Flag, welches die kontrollierte Beendigung von ExecuteActionPlan() zum nächstmöglichen Zeitpunkt veranlasst/signalisiert und kehrt dann sofort zurück. Auf diese Weise kann z.B. Maßnahmensteigerung durch wiederholte Ausführung des Aktionsplans umgesetzt werden. Die eigenliche Maßnahmensteigerung ist nach Beendigung von ActionPlan.ExecuteActionPlan() in Processes.ExecuteActionPlan() vorzusehen (s. Zusammenhängendes Beispiel für die Autorengesteuerte Maßnahmensteigerung).

Vor- und Nachbereiter für den Aktionsplan (PreparePlan(), FinishPlan()) werden auch im Restart-Fall-ausgeführt.

Zu beachten:

Die Funktion ist primär für die Autorengesteuerte Maßnahmensteigerungsbehandlung sinnvoll.

Im Sinne einer für den Autoren möglichst transparenten Maßnahmensteigerungsbehandlung führt RestartActionPlan() folgende Schritte selbständig aus:

1. Deaktivieren des Therapieplan-orientierten Abbruchmodells für die aktuell ausgeführte Aktion (entspricht Autorenaufruf TherapyPlanAction.SetContinueOnError(true) und kann demzufolge mittels TherapyPlanAction.SetContinueOnError(false) nach RestartActionPlan() rückgängig gemacht werden).
2. Deaktivieren des Steuergeräte-orientierten Abbruchmodells für die aktuell ausgeführte Aktion (entspricht Autorenaufruf TherapyPlanAction.SetContinueWithEcuOnError(true) und kann demzufolge mittels TherapyPlanAction.SetContinueWithEcuOnError(false) nach RestartActionPlan() rückgängig gemacht werden).
3. Aktualisieren des Aktionsplans (entspricht Autorenaufruf ActionPlan.DoTp2Ap())

  Boolean DoFlash( Isom.Plan.TherapyPlanAction action ) 
  { 
      // if ( ....Failed() ) 
      { 
          Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
          Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 

          // Neustart der Aktionsplanausführung veranlassen 
          if( ap.RestartActionPlan().Failed() ) 
          { 
              Log.Error ("", "Neustart des Aktionsplans fehlgeschlagen."); 
          } 
      } 
  } 

Rückgabe:

'true' im Erfolgsfall, 'false' sonst.

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls sich ISOM nicht im Aktionsplan-Ausführungszustand befindet.

Siehe auch:

Zusammenhängendes Beispiel für die Autorengesteuerte Maßnahmensteigerung für ein zusammenhängendes Beispiel.

Isom.Plan.ActionPlan.IsActionPlanRestarting() für die Funktion zur Prüfung, ob ein Neustart stattgefunden hat.

Die Funktion Resume setzt die Aktionsplanausführung fort, nachdem sie durch Pause() angehalten wurde.

Rückgabe:

'true' wenn die Aktionsplanausführung erfolgreich fortgesetzt werden konnte.

'false' wenn die Aktionsplanausführung nicht fortgesetzt werden konnte, weil sie zuvor nicht erfolgreich angehalten wurde.

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben, falls die Aktionsplanausführung nicht wieder aufgenommen werden konnte, da die Funktionalität nicht zur Verfügung steht oder weil ein Fachdienstaufruf gescheitert ist. Dies ist auch der Fall, wenn der verwendete Fachdienst das Funktionsmerkmal nicht unterstützt.

Siehe auch:

Isom.Plan.ActionPlan.Pause() zum Unterbrechen einer Sitzung mit Möglichkeit zum Fortsetzen.

Setzt eine evtl.

existierende konservierte Sitzung fort.

Für Top-Level-Aufrufe sollte stattdessen die verschattete Funktion Isom.Global.Processes.CheckForPreservedSession() verwendet werden.

Rückgabe:

'true' wenn eine Sitzung wiederaufgeweckt wurde, 'false' sonst

Legt die Ausführungsreihenfolge aller asynchronen Aktionen innerhalb einer Ausführungsgruppe fest.

  Boolean SetExecutionOrder() 
  { 
      Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
      Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 

      ap.SetExecutionOrders     ( "IsomPreFlash"   ); // von ISOM ausgef. 
      ap.SetExecutionOrderGroup ( "TAL_Reassembly" ); // extern ausgeführt 
      ap.SetExecutionOrders     ( "IsomPstFlash"   ); // von ISOM ausgef. 
      // ... 
      return true; // success 
  } 

Parameter:

actionplangroupRegex

(Isom.Base.String) Regulärer Ausdruck, der auf eine oder mehrere Ausführungsgruppen passt.

Rückgabe:

Isom.Base.Boolean
true, falls Fachfunktionsaufruf erfolgreich
false sonst.

Zu beachten:

Die Ausführungsgruppen werden über die Annotation [ActionPlanGroup] festgelegt.

Diese Funktion darf ausschließlich innerhalb der Rückruffunktion SetExecutionOrder verwendet werden.

Diese Funktion hat nur Relevanz, wenn die Planausführung über ein ISOM-externes Ausführungssystem partiell oder ganz gesteuert wird.

Die Reihenfolge der Aufrufe dieser Funktion und der Funktion SetExecutionOrders bestimmt die erzwungene Ausführungsreihenfolge.

Wird für eine Aktion keine Aktionsreihenfolge explizit festgelegt, bleibt die Einfügereihenfolge im Therapieplan bzw. die von der Logistik vorgegebene Reihenfolge erhalten.

Siehe auch:

Isom.Plan.ActionPlan.SetExecutionOrders

Annotation [ActionPlanGroup]

Legt die Ausführungsreihenfolge der Aktionen fest.

Die Reihenfolge der Aufrufe dieser Funktion und der Funktion SetExecutionOrdersAsyncBlock() bestimmt die erzwungene Ausführungsreihenfolge.

Als 'actionname' werden sowohl virtuelle Aktionen (z.B. 'RetofitCCC') als auch konkrete Aktionen (z.B. 'Code') zugelassen. Neben vollständigen Aktionsnamen werden auch reguläre Ausdrücke in C#-Syntax als 'actionname' akzeptiert (z.B. 'Init.*').

Wird für eine Aktion keine Aktionsreihenfolge explizit festgelegt, bleibt die Einfügereihenfolge im Therapieplan bzw. die von der Logistik vorgegebene Reihenfolge erhalten.

Diese Funktion sollte ausschließlich innerhalb der ISOM/L-Funktion SetExecutionOrder() verwendet werden.

  Boolean SetExecutionOrder() 
  { 
      Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
      Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 

      ap.SetExecutionOrders( "Flash"  ); 
      ap.SetExecutionOrders( "Code"   ); 
      ap.SetExecutionOrders( "Init.*" ); 
      // Alle Flash Aktionen werden vor allen Code Aktionen ausgeführt 
      // Alle Aktionen, die mit "Init" beginnen werden danach ausgeführt. 
      // ... 
      return true; // success 
  } 

Rückgabe:

'true' wenn die Ausführungsreihenfolge erfolgreich festgelegt werden konnte, 'false' sonst.

Die Funktion SetOrderList setzt die anzuzeigenden Bestellinformationen.

Die Übergabeparameter sind drei Einzellisten, die jeweils Zeichenketten für

• Aktion
• Steuergerät
• Bestellnummer bzw. einen Ersatz für selbige enthalten.

Rückgabe:

'true'

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben bei Aufruf mit einem Void-Objekt oder wenn die Listen unterschiedlich viele Elemente besitzen.

Setzt den Wert der vorgegebenen Eigenschaft (property) des Aktionsplans.

Die systemseitig ermittelten Eigenschaftsnamen sind in den herstellerspezifischen Begleitdokumenten zu finden.

  Isom.Plan.TherapyPlan tp = Isom.Plan.TherapyPlan.GetInstance(); 
  Isom.Plan.ActionPlan  ap = Isom.Plan.ActionPlan.GetInstance( tp ); 
  Isom.Base.String propName = "SomeOemSpecificName"; 
  if( ap.GetProp(propName).IsVoid() ) 
  { 
      ap.SetProp( propName, "true" ); 
  } 

Rückgabe:

liefert immer 'true'

Zeigt eine Repräsentation des Aktionsplanes als Popup-Messagebox.

Rückgabe:

immer 'true'

Die Funktion SignalUserInteractionsDone gibt für die Aktion, aus der SignalUserInteractionsDone aufgerufen wird, an, dass in der weiteren Ausführung keine Benutzerinteraktionen mehr angezeigt werden und aktualisiert die Zeitprognose bis zur nächsten Benutzerinteraktion dementsprechend.

Rückgabe:

'true'

Ausnahmebehandlung:

Es wird das Void-Objekt zurückgegeben bei Aufruf mit einem Void-Objekt oder wenn die Funktion nicht aus einer ausgeführten Aktion heraus aufgerufen wird.

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.