Isom.Context.VehicleOrder

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Context.VehicleOrder

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Context.VehicleOrder

Beschreibung

Ein Fahrzeugauftrag (FA) beschreibt wesentliche funktionelle Aspekte der Fahrzeugkonfiguration eines konkreten Fahrzeugs.



Funktionen

Isom.Context.VehicleOrder.Add

Fügt ein Fahrzeugauftragselement zum FA-Hauptspeicherabbild hinzu.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.Add  ( Isom.Base.String  faElem  ) 

Fügt ein Fahrzeugauftragselement zum FA-Hauptspeicherabbild hinzu.

   using Isom.Base.* 
   ... 
      Boolean FilterRetrofit...( TherapyPlanAction action ) 
      { 
          FutureVehicleContext fvc = FutureVehicleContext.GetInstance(); 
          VehicleOrder voCopy = fvc.GetVehicleOrderClone(); 

          voCopy.Add( "$609" ); // entspr. FaManipulationen ADD $609 
          ... 
          fvc.ChangeVehicleOrder( voCopy ); 
          ... 
      } 
Rückgabe:
'true', falls wirklich das Element hinzugefügt wurde, d.h. die FA-Objektkopie das FA-Element noch nicht enthielt und das Einfügen erfolgreich war, 'false' sonst.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die Funktion auf dem FA im aktuellen Ist-Kontext (CurrentVehiclecontext.GetInstance().GetVehicleOrderClone()) aufgerufen wird (ISOM verwaltet dieses Datenobjekt).
Es wird das Void-Objekt zurückgegeben, falls die Funktion auf dem FA im aktuellen Soll-Kontext (FutureVehicleContext.GetInstance().GetVehicleOrderClone()) aufgerufen wird (VehicleOrder.Clone() und FutureVehicleContext.ChangeVehicleOrder() ist zu benutzen).
Isom.Context.VehicleOrder.Clone

Erzeugt eine identische Kopie des Objekts.

objectbound Isom.Context.VehicleOrder Isom.Context.VehicleOrder.Clone  (  ) 

Erzeugt eine identische Kopie des Objekts.

Rückgabe:
Das geklonte Objekt.
Isom.Context.VehicleOrder.Contains

Prüft, ob der Fahrzeugauftrag das Element enthält.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.Contains  ( Isom.Base.String  faElem  ) 

Prüft, ob der Fahrzeugauftrag das Element enthält.

Das übergebene FA-Element muss ein gültiges FA-Element inklusive vorangestellten FA-Typkennzeichen sein.

Rückgabe:
'true', falls das Element im FA gefunden wurde, 'false' sonst.
Isom.Context.VehicleOrder.Equals

Vergleicht zwei Fahrzeugaufträge auf semantische Gleichheit.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.Equals  ( Isom.Context.VehicleOrder  vo  ) 

Vergleicht zwei Fahrzeugaufträge auf semantische Gleichheit.

Die Funktion vergleicht, ob zwei Fahrzeugaufträge semantisch gleich sind. Dabei wird berücksichtigt, dass sich die Reihenfolge der Fahrzeugauftragselemente in den beiden Fahrzeugaufträgen unterscheiden kann, die beiden jedoch dieselbe Information darstellen, falls sie die gleichen Elemente besitzen. Die Funktion erzeugt von den beiden zu vergleichenden Fahrzeugaufträgen zunächst Kopien. Auf diesen Kopien wird dann die Normalisierungsfunktion Normalize() durchgeführt. Der Vergleich erfolgt dann über die Zeichenkettenrepräsentationen der normalisierten Fahrzeugaufträge. Die beiden zu vergleichenden Fahrzeugaufträgen werden somit nicht verändert, die Reihenfolge der Elemente bleibt erhalten.

      VehicleOrder vo1 = CurrentVehicleContext.GetInstance ().GetVehicleOrderClone (); 
      VehicleOrder vo2 = CurrentVehicleContext.GetInstance ().GetVehicleOrderClone (); 
      vo2.Normalize(); 
      Boolean isEqual = false; 
      isEqual = vo1.Equals ( vo2 ); 
      if ( isEqual ) 
      { 
          System.Stdout( "Die Fahrzeugaufträge sind gleich." ); 
      } 
      else 
      { 
          System.Stdout( "Die Fahrzeugaufträge sind nicht gleich." ); 
      } 
Rückgabe:
'true', falls die Fahrzeugaufträge gleich sind.
Isom.Context.VehicleOrder.EvaluateTerm

Prüft, ob der angegebene Term für diesen Fahrzeugauftrag erfüllt ist.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.EvaluateTerm  ( Isom.Base.String  faTerm  ) 

Prüft, ob der angegebene Term für diesen Fahrzeugauftrag erfüllt ist.

Der übergebene FA-Term darf nur AND, OR, (, ) und FA-Elemente enthalten. Anstelle eines FA-Elements sind auch folgende spezielle Schlüsselworte erlaubt: TRUE (immer "wahr") FALSE (immer "falsch") FLASHABLE ("wahr", wenn das aktuelle Steuergerät programmierbar ist) CODEABLE ("wahr", wenn das aktuelle Steuergerät codierbar ist) Zusätzlich werden folgende spezielle Syntaxformen unterstützt: Planned:<ActionName> (wahr, wenn die vorgegebene Aktion im Therapieplan enthalten ist. Ein Steuergerätebezug wird dabei unterstützt. Beispiel: [EditableEcuAction ("Flash", Texts.ACTION_ECU_FLASH, "FLASHABLE AND NOT Planned:Replace")] ) ManuallyPlanned:<ActionName> (wahr, wenn die vorgegebene Aktion manuell dem Therapieplan hinzugefügt wurde. Ein Steuergerätebezug wird dabei unterstützt. Beispiel: [EditableEcuAction ("Flash", Texts.ACTION_ECU_FLASH, "FLASHABLE AND NOT ManuallyPlanned:Replace")] )

   using Isom.Base.* 
   ... 
  CurrentVehicleContext currentContext = CurrentVehicleContext.GetInstance(); 
  VehicleOrder vo = futureContext.GetVehicleOrderClone(); 
  if( vo.EvaluateTerm( "§PU05 AND ($609 OR $610)" ) 
      ... 
Rückgabe:
'true', falls das Element im FA gefunden wurde, 'false' sonst.
Isom.Context.VehicleOrder.GetImportURI

Liefert die URI, an der ISOM den zu importierenden Fahrzeugauftrag erwartet.

Isom.Base.String Isom.Context.VehicleOrder.GetImportURI  (  ) 

Liefert die URI, an der ISOM den zu importierenden Fahrzeugauftrag erwartet.

Zur Benutzung der Funktion bitte Code-Beispiel beachten.

   using Isom.Base.* 
   ... 
      String uriVO; 
      uriVO = VehicleOrder.GetImportURI(); 
      if( uriVO.IsVoid() ) 
      { 
          // Fehlerbehandlung 
      } 
Rückgabe:
URI, falls erfolgreich.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls ein Fehler aufgetreten ist.
Isom.Context.VehicleOrder.GetModelSeries

Ermittelt die [reale] Baureihe aus dem Fahrzeugauftrag.

objectbound Isom.Base.String Isom.Context.VehicleOrder.GetModelSeries  (  ) 

Ermittelt die [reale] Baureihe aus dem Fahrzeugauftrag.

Rückgabe:
[reale] Baureihe
Isom.Context.VehicleOrder.GetOemFormat

Liefert den Fahrzeugauftrag im OEM-spezifischen Format als Wörterbuch.

objectbound Isom.Base.StringDictionary Isom.Context.VehicleOrder.GetOemFormat  (  ) 

Liefert den Fahrzeugauftrag im OEM-spezifischen Format als Wörterbuch.

Das Wörterbuch wird im OEM-Fachdienstproxy befüllt.

Der Oem kann im Wörterbuch ein oder mehrere Schlüssel-Werte-Paare eintragen. So kann es z.B. einen Eintrag geben der den Fahrzeugauftrag exakt so enthält wie er aus dem Fahrzeug gelesen wurde. Denkbar ist auch, dass der Fahrzeugauftrag in mehrere logische Teile gegliedert wird und über das Wörterbuch mit verschiedenen Schlüsseln abfragbar ist.

   using Isom.Base.* 
   ... 
   StringDictionary faOEM = CurrentVehicleContext.GetInstance().GetVehicleOrderClone().GetOemFormat(); 
   StringList keys = faOEM.GetKeys(); 
   keys.Reset(); 
   while( keys.HasNext() ) 
   { 
     String faKey = keys.Next(); 
     String faValue = faOEM.Get(faKey); 
     String originalFA = "FA-OemFormat: Schlüssel("; 
     originalFA.Append( faKey ); 
     originalFA.Append( ") Wert(" ); 
     originalFA.Append( faValue ); 
     originalFA.Append( ")" ); 
     // Wert ausgeben, in der Ereignisaufzeichnung eintragen, ... 
   } 

Rückgabe:
Wörterbuch mit dem Fahrzeugauftrag im Oem-Format
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls ein Fehler aufgetreten ist.
Isom.Context.VehicleOrder.GetProperties

Liefert eine Liste von Fahrzeugauftragselementen für den übergebenen Schlüssel.

objectbound Isom.Base.StringList Isom.Context.VehicleOrder.GetProperties  ( Isom.Base.String  key  ) 

Liefert eine Liste von Fahrzeugauftragselementen für den übergebenen Schlüssel.

   using Isom.Base.* 
   ... 
   CurrentVehicleContext cvc = CurrentVehicleContext.GetInstance(); 
   VehicleOrder vo = cvc.GetVehicleOrderClone(); 
   StringList elements = vo.GetProperties( "Extras" ); 
   while( elements.HasNext() ) 
   { 
       String key = elements.Next(); 
       System.Stdout( key ); 
   } 
Rückgabe:
Liste von Fahrzeugauftragselementen, falls erfolgreich.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls ein Fehler aufgetreten ist.
Isom.Context.VehicleOrder.GetPropertiesKeys

Liefert eine Liste von allen Schlüsseln, für die es Fahrzeugauftragselemente gibt.

objectbound Isom.Base.StringList Isom.Context.VehicleOrder.GetPropertiesKeys  (  ) 

Liefert eine Liste von allen Schlüsseln, für die es Fahrzeugauftragselemente gibt.

   using Isom.Base.* 
   ... 
   CurrentVehicleContext cvc = CurrentVehicleContext.GetInstance(); 
   VehicleOrder vo = cvc.GetVehicleOrderClone(); 
   StringList allKeys = vo.GetPropertiesKeys(); 
   allKeys.Reset(); 
   while( allKeys.HasNext() ) 
   { 
       String key = allKeys.Next(); 
       System.Stdout( key ); 
   } 

Rückgabe:
Liste von Schlüsseln, falls erfolgreich.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls ein Fehler aufgetreten ist.
Isom.Context.VehicleOrder.IsValid

Prüft einen Fahrzeugauftrag auf Gültigkeit.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.IsValid  (  ) 

Prüft einen Fahrzeugauftrag auf Gültigkeit.

Rückgabe:
'true', falls der Fahrzeugauftrag keine unzulässigen Elemente enthält, 'false' sonst
Isom.Context.VehicleOrder.IsVoid

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

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.IsVoid  (  ) 

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

Rückgabe:
'true', falls dies das Void-Objekt ist, 'false' sonst.
Isom.Context.VehicleOrder.Normalize

Normalisiert den Fahrzeugauftrag.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.Normalize  (  ) 

Normalisiert den Fahrzeugauftrag.

Die Funktion sortiert die Elemente des Fahrzeugauftrages. Es werden keine Elemente entfernt oder hinzugefügt.

      VehicleOrder voUnsorted = CurrentVehicleContext.GetInstance ().GetVehicleOrderClone (); 
      System.Stdout ( voUnsorted.ToString( ) ); 
      voUnsorted.Normalize ( ); 
      System.Stdout ( voUnsorted.ToString( ) ); 
Rückgabe:
'true' falls erfolgreich.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die Funktion auf dem FA im aktuellen Ist-Kontext (CurrentVehiclecontext.GetInstance().GetVehicleOrderClone()) aufgerufen wird (ISOM verwaltet dieses Datenobjekt).
Isom.Context.VehicleOrder.Remove

Entfernt ein Fahrzeugauftragselement aus dem FA-Hauptspeicherabbild.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.Remove  ( Isom.Base.String  faElem  ) 

Entfernt ein Fahrzeugauftragselement aus dem FA-Hauptspeicherabbild.

   using Isom.Base.* 
   ... 
      Boolean FilterRetrofit...( TherapyPlanAction action ) 
      { 
          FutureVehicleContext fvc = FutureVehicleContext.GetInstance(); 
          VehicleOrder voCopy = fvc.GetVehicleOrderClone(); 

          voCopy.Remove( "$609" ); // entspr. FaManipulationen REMOVE $609 
          ... 
          fvc.ChangeVehicleOrder( voCopy ); 
          ... 
      } 
Rückgabe:
'true', falls wirklich das Element entfernt wurde, d.h. die FA-Objektkopie das FA-Element bereits enthielt und das Entfernen erfolgreich war, 'false' sonst.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die Funktion auf dem FA im aktuellen Ist-Kontext (CurrentVehiclecontext.GetInstance().GetVehicleOrderClone()) aufgerufen wird (ISOM verwaltet dieses Datenobjekt).
Es wird das Void-Objekt zurückgegeben, falls die Funktion auf dem FA im aktuellen Soll-Kontext (FutureVehicleContext.GetInstance().GetVehicleOrderClone()) aufgerufen wird (VehicleOrder.Clone() und FutureVehicleContext.ChangeVehicleOrder() ist zu benutzen).
Isom.Context.VehicleOrder.SetModelSeries

Setzt die [reale] Baureihe im Fahrzeugauftrag.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.SetModelSeries  ( Isom.Base.String  newModelSeries  ) 

Setzt die [reale] Baureihe im Fahrzeugauftrag.

Rückgabe:
true bei Erfolg.
Zu beachten:
Diese Funktion ist ausschließlich zur Verwendung innerhalb von Umschlüsselungen vorgesehen.
Isom.Context.VehicleOrder.SetProperties

Setzt eine Liste von Fahrzeugauftragselementen für den übergebenen Schlüssel.

objectbound Isom.Base.Boolean Isom.Context.VehicleOrder.SetProperties  ( Isom.Base.String  key,
Isom.Base.StringList  properties  )

Setzt eine Liste von Fahrzeugauftragselementen für den übergebenen Schlüssel.

   using Isom.Base.* 
   ... 
   CurrentVehicleContext cvc = CurrentVehicleContext.GetInstance(); 
   VehicleOrder vo = cvc.GetVehicleOrderClone(); 
   StringList modelType = StringList.CreateStringList(); 
   modelType.Insert( "NA71" ); 
   Boolean ret; 
   ret = vo.SetProperties( "TypeCode", modelType ); 
   // Fehlerbehandlung falls ret!=true 
   // ... 
Rückgabe:
'true' falls erfolgreich. 'false' falls der übergebene Schlüssel eine leere Zeichenkette ist.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls ein Fehler aufgetreten ist.
Isom.Context.VehicleOrder.ToString

Ermittelt die [unnormierte] String-Repräsentation des Fahrzeugauftrags.

objectbound Isom.Base.String Isom.Context.VehicleOrder.ToString  (  ) 

Ermittelt die [unnormierte] String-Repräsentation des Fahrzeugauftrags.

Rückgabe:
[nicht normierte] String-Repräsentation des Fahrzeugauftrags.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls im Objekt noch kein FA-String verfügbar ist.
Isom.Context.VehicleOrder.Void

Erzeugt ein ungültiges Objekt.

Isom.Context.VehicleOrder Isom.Context.VehicleOrder.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