Isom.Context.LogicalUnit

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

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Context.LogicalUnit

Beschreibung

Isom.Context.LogicalUnit repräsentiert eine logische Einheit, die im ISOM-Objektmodell eine Hardware- oder Softwarekomponente eines Steuergeräts modelliert.



Funktionen

Isom.Context.LogicalUnit.Clone

Liefert eine tiefe Kopie des Objekts

objectbound Isom.Context.LogicalUnit Isom.Context.LogicalUnit.Clone  (  ) 

Liefert eine tiefe Kopie des Objekts

Rückgabe:
Tiefe Kopie des aufgerufenen Objekts
Isom.Context.LogicalUnit.CreateNew

Erzeugt eine Instanz von LogicalUnit

Isom.Context.LogicalUnit Isom.Context.LogicalUnit.CreateNew  (  ) 

Erzeugt eine Instanz von LogicalUnit

 //Instanz einer logischen Einheit erzeugen 
 LogicalUnit logicalUnit = logicalUnit.CreateNew(); 
Rückgabe:
Eine Instanz der logischen Einheit
Category = Void-Objekt
Key = Void-Objekt
Version = 0.0.0.0
Ausnahmebehandlung:
keine
Isom.Context.LogicalUnit.GetCategory

Fragt die Kategorie ab, zu der diese logische Einheit gehört

objectbound Isom.Base.String Isom.Context.LogicalUnit.GetCategory  (  ) 

Fragt die Kategorie ab, zu der diese logische Einheit gehört

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Kategorie der logischen Einheit setzen 
 logicalUnit.SetCategory("SWFL"); 

 //Abfrage der Kategorie der logischen Einheit 
 String category = logicalUnit.GetCategory(); 

Rückgabe:
Kategorie der logischen Einheit
Ausnahmebehandlung:
Es wird das Void-Objekt geliefert, wenn keine Kategorie festgelegt wurde.
Isom.Context.LogicalUnit.GetKey

Fragt den Schlüssel einer logischen Einheit ab

objectbound Isom.Base.String Isom.Context.LogicalUnit.GetKey  (  ) 

Fragt den Schlüssel einer logischen Einheit ab

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Schlüssel für die logische Einheit setzen 
 logicalUnit.SetKey("00000895"); 

 //Abfrage des Schlüssels der logischen Einheit 
 String rev = logicalUnit.GetKey(); 

Rückgabe:
Schlüssel der logischen Einheit
Ausnahmebehandlung:
Es wird das Void-Objekt geliefert, wenn kein Schlüssel festgelegt wurde.
Isom.Context.LogicalUnit.GetOrderingInfo

Fragt die Bestellinformationen dieser logischen Einheit ab

objectbound Isom.Plan.OrderingInfoList Isom.Context.LogicalUnit.GetOrderingInfo  (  ) 

Fragt die Bestellinformationen dieser logischen Einheit ab

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Erzeugt ein neues, leeres Objekt für eine Bestellalternative 
 OrderingInfo orderInfo = OrderingInfo.CreateNew(); 

 //Typ des Liefermediums setzen 
 orderInfo.SetMedium("CDROM"); 
 // Bestellinformationen befüllen 
 ... 

 //Liste von Bestellalternativen erzeugen 
 OrderingInfoList orderingInfoList = OrderingInfoList.CreateOrderingInfoList(); 
 //Bestellinfo in die Liste hinzufügen 
 orderingInfoList.Insert(orderInfo); 

 //Bestellinformationen der logischen Einheit setzen 
 logicalUnit.SetOrderingInfo(orderingInfoList); 

 //Bestellinformationen der logischen Einheit abfragen 
 OrderingInfoList logOrderingInfoList = logicalUnit.GetOrderingInfo(); 

Rückgabe:
Bestellinformationen der logischen Einheit
Ausnahmebehandlung:
Es wird das Void-Objekt geliefert, wenn keine Bestellinformationen festgelegt wurden.
Isom.Context.LogicalUnit.GetProp

Fragt eine autorendefinierte Eigenschaft der logischen Einheit ab

objectbound Isom.Base.String Isom.Context.LogicalUnit.GetProp  ( Isom.Base.String  propName  ) 

Fragt eine autorendefinierte Eigenschaft der logischen Einheit ab

 //Es wird mit diesem Beispiel BTLD_0000121F-006_010_000 gearbeitet 
 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Eigenschaft 'DisplayText' setzen 
 logicalUnit.SetProp("DisplayText", "BTLD_0000121F-006_010_000"); 

 // Eigenschaft abfragen 
 String displayText = logicalUnit.GetProp("DisplayText"); 

Parameter:
propName  Bezeichnung der autorendefinierten Eigenschaft
Rückgabe:
Wert der autorendefinierten Eigenschaft mit dem Namen propName
Ausnahmebehandlung:
Es wird das Void-Objekt geliefert, wenn keine autorendefinierte Eigenschaft propName festgelegt wurde
Isom.Context.LogicalUnit.GetPropNames

Diese Funktion ruft eine Liste der Bezeichnungen aller autorendefinierten Eigenschaften des Objekts ab.

objectbound Isom.Base.StringList Isom.Context.LogicalUnit.GetPropNames  (  ) 

Diese Funktion ruft eine Liste der Bezeichnungen aller autorendefinierten Eigenschaften des Objekts ab.

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Eigenschaft 'DisplayText' setzen 
 logicalUnit.SetProp("DisplayText", "BTLD_0000121F-006_010_000"); 
 //weitere Eigenschaften setzen 
 ... 

 //Liste der Bezeichnungen abfragen 
 StringList propNames = logicalUnit.GetPropNames(); 

Rückgabe:
Liste der Bezeichnung aller autorendefinierten Eigenschaften
Isom.Context.LogicalUnit.GetStates

Ruft eine Liste aller Zustände ab, in denen sich die logische Einheit befindet

objectbound Isom.Base.StringList Isom.Context.LogicalUnit.GetStates  (  ) 

Ruft eine Liste aller Zustände ab, in denen sich die logische Einheit befindet

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Zustände setzen 
 logicalUnit.SetState("Isom.Source.Logistics"); 
 logicalUnit.SetState("Isom.Execution.Failed"); 

 StringList states = logicalUnit.GetStates(); 

Rückgabe:
Liste aller Zustände, in denen sich die logische Einheit befindet
Isom.Context.LogicalUnit.GetVersion

Fragt die Versionsnummer der logischen Einheit ab

objectbound Isom.Base.Version Isom.Context.LogicalUnit.GetVersion  (  ) 

Fragt die Versionsnummer der logischen Einheit ab

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 
 //die Versionsnummer ist per Definition mit Nuller befüllt: 0.0.0.0 

 //Abfrage der Versionsnummer der logischen Einheit 
 Version logicalUnitVersion = logicalUnit.GetVersion(); 
Rückgabe:
Versionsnummer der logischen Einheit
Ausnahmebehandlung:
Es wird das Void-Objekt geliefert, wenn wenn zuvor das Void-Objekt als Version gesetzt wurde.
Isom.Context.LogicalUnit.InvalidateProp

Löscht eine autorendefinierte Eigenschaft der logischen Einheit

objectbound Isom.Base.Boolean Isom.Context.LogicalUnit.InvalidateProp  ( Isom.Base.String  propName  ) 

Löscht eine autorendefinierte Eigenschaft der logischen Einheit

 //Es wird mit diesem Beispiel BTLD_0000121F-006_010_000 gearbeitet 
 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Eigenschaft 'DisplayText' setzen 
 logicalUnit.SetProp("DisplayText", "BTLD_0000121F-006_010_000"); 

 //Eigenschaft löschen 
 Boolean result = logicalUnit.InvalidateProp("DisplayText"); 

Parameter:
propName  Bezeichnung der autorendefinierten Eigenschaft
Rückgabe:
true, wenn der Wert der autorendefinierten Eigenschaft gelöscht wurde oder nicht gesetzt war
Ausnahmebehandlung:
Es wird das Void-Objekt geliefert, wenn propName den Wert String.Void() hatte.
Isom.Context.LogicalUnit.IsInState

Prüft, ob sich die logische Einheit in einem angegebenen Zustand befindet

objectbound Isom.Base.Boolean Isom.Context.LogicalUnit.IsInState  ( Isom.Base.String  state  ) 

Prüft, ob sich die logische Einheit in einem angegebenen Zustand befindet

 //Es wird mit diesem Beispiel BTLD_0000121F-006_010_000 gearbeitet 
 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Schlüssel setzen 
 logicalUnit.SetKey("0000121F"); 

 //Kategorie setzen 
 logicalUnit.SetCategory("BTLD"); 

 //Version erzeugen 
 Version v = Version.Parse("006_010_000", "_"); 

 //Version hinzufügen 
 logicalUnit.SetVersion(v); 

 //Zustand setzen 
 logicalUnit.SetState("Isom.Source.Ecu"); 

 Boolean result = logicalUnit.IsInState("Isom.Source.Ecu"); 

Parameter:
state  Bezeichnung des Zustands
Rückgabe:
true, wenn sich die logische Einheit im angegebenen Zustand befindet; false, wenn sich die logische Einheit in einem anderen Zustand befindet
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der angegebene Zustand nicht gefunden wurde.
Isom.Context.LogicalUnit.IsVoid

Prüft, ob die aktuelle Instanz das ungültige Objekt ist

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

Prüft, ob die aktuelle Instanz das ungültige Objekt ist

Rückgabe:
true, wenn die aktuelle Instanz das ungültige Objekt ist
Isom.Context.LogicalUnit.SetCategory

Legt die Kategorie fest, zu der diese logische Einheit gehört

objectbound Isom.Base.Boolean Isom.Context.LogicalUnit.SetCategory  ( Isom.Base.String  category  ) 

Legt die Kategorie fest, zu der diese logische Einheit gehört

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Kategorie der logischen Einheit setzen 
 Boolean result = logicalUnit.SetCategory("SWFL"); 

Parameter:
category  Kategorie der logischen Einheit
Rückgabe:
true, wenn die Kategorie erfolgreich gesetzt wurde
Isom.Context.LogicalUnit.SetKey

Legt den Schlüssel einer logischen Einheit fest

objectbound Isom.Base.Boolean Isom.Context.LogicalUnit.SetKey  ( Isom.Base.String  key  ) 

Legt den Schlüssel einer logischen Einheit fest

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Schlüssel für die logische Einheit setzen 
 Boolean result = logicalUnit.SetKey("00000895"); 
Parameter:
key  Schlüssel der logischen Einheit
Rückgabe:
true, wenn der Schlüssel erfolgreich gesetzt wurde
Isom.Context.LogicalUnit.SetOrderingInfo

Legt die Bestellinformationen dieser logischen Einheit fest

objectbound Isom.Base.Boolean Isom.Context.LogicalUnit.SetOrderingInfo  ( Isom.Plan.OrderingInfoList  orderingInfo  ) 

Legt die Bestellinformationen dieser logischen Einheit fest

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Erzeugt ein neues, leeres Objekt für eine Bestellalternative 
 OrderingInfo orderInfo = OrderingInfo.CreateNew(); 

 //Typ des Liefermediums setzen 
 orderInfo.SetMedium("CDROM"); 
 // Bestellinformationen befüllen 
 ... 

 //Liste von Bestellalternativen erzeugen 
 OrderingInfoList orderingInfoList = OrderingInfoList.CreateOrderingInfoList(); 
 //Bestellinfo in die Liste hinzufügen 
 orderingInfoList.Insert(orderInfo); 

 //Bestellinformationen der logischen Einheit setzen 
 logicalUnit.SetOrderingInfo(orderingInfoList); 

Parameter:
orderingInfo  Liste der möglichen Bestellalternativen.
Rückgabe:
true, wenn die möglichen Bestellalternativen erfolgreich festgelegt wurden.
Isom.Context.LogicalUnit.SetProp

Legt eine autorendefinierte Eigenschaft der logischen Einheit fest.

objectbound Isom.Base.Boolean Isom.Context.LogicalUnit.SetProp  ( Isom.Base.String  propName,
Isom.Base.String  propValue  )

Legt eine autorendefinierte Eigenschaft der logischen Einheit fest.

Wurde der Wert zuvor bereits festgelegt, wird der vorherige Wert überschrieben.

 //Es wird mit diesem Beispiel BTLD_0000121F-006_010_000 gearbeitet 
 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Eigenschaft 'DisplayText' setzen 
 logicalUnit.SetProp("DisplayText", "BTLD_0000121F-006_010_000"); 

Parameter:
propName  Bezeichnung der autorendefinierten Eigenschaft
propValue  Wert der autorendefinierten Eigenschaft
Rückgabe:
true, wenn der Wert der autorendefinierten Eigenschaft übernommen wurde
Ausnahmebehandlung:
Es wird das Void-Objekt geliefert, wenn versucht wird, den Wert String.Void() für propValue zu übergeben. Zum Löschen einer autorendefinierten Eigenschaft wird LogicalUnit.InvalidateProp verwendet.
Isom.Context.LogicalUnit.SetState

Setzt den Zustand der logischen Einheit im passenden Zustandsautomaten

objectbound Isom.Base.Boolean Isom.Context.LogicalUnit.SetState  ( Isom.Base.String  state  ) 

Setzt den Zustand der logischen Einheit im passenden Zustandsautomaten

 //Es wird mit diesem Beispiel BTLD_0000121F-006_010_000 gearbeitet 
 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Schlüssel setzen 
 logicalUnit.SetKey("0000121F"); 

 //Kategorie setzen 
 logicalUnit.SetCategory("BTLD"); 

 //Version erzeugen 
 Version v = Version.Parse("006_010_000", "_"); 

 //Version hinzufügen 
 logicalUnit.SetVersion(v); 

 //Zustand setzen 
 logicalUnit.SetState("Isom.Source.Ecu"); 

Parameter:
state  vollqualifizierte Bezeichnung des Zustands
Rückgabe:
true, wenn der Zustand gesetzt wurde
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die Angabe des Zustands nicht vollqualifiziert war.
Isom.Context.LogicalUnit.SetVersion

Legt die Versionsnummer dieser logischen Einheit fest

objectbound Isom.Base.Boolean Isom.Context.LogicalUnit.SetVersion  ( Isom.Base.Version  version  ) 

Legt die Versionsnummer dieser logischen Einheit fest

 LogicalUnit logicalUnit = LogicalUnit.CreateNew(); 

 //Version erzeugen 
 //Verwendung der Funktion Parse: sie wertet eine Zeichenkette aus, 
 //die eine Versionsnummer enthält, und erzeugt daraus eine Instanz von Isom.Base.Version 
 Version ver = Version.Parse( "2.10.13.5", "." ); 

 //Version in die logische Einheit hinzufügen 
 Boolean result = logicalUnit.SetVersion(ver); 
Parameter:
version  Versionsnummer der logischen Einheit.
Rückgabe:
true, wenn die Versionsnummer erfolgreich gesetzt wurde.
Isom.Context.LogicalUnit.Void

Liefert das ungültige Objekt des Namensraums Isom.Context.LogicalUnit

Isom.Context.LogicalUnit Isom.Context.LogicalUnit.Void  (  ) 

Liefert das ungültige Objekt des Namensraums Isom.Context.LogicalUnit

Rückgabe:
Ungültige Objekt des Namensraums Isom.Context.LogicalUnit

Version 9.10.1.0 vom 25 November 2013