Isom.Services.AsamParameterList

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Services.AsamParameterList

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Services.AsamParameterList

Beschreibung

Ein Parameter kann selbst weitere (Unter-)Parameter enthalten. Er bietet daher die Funktionalität einer Liste, deren Elemente per Index oder per Name abgerufen werden können.



Funktionen

Isom.Services.AsamParameterList.At

Liefert den Parameter am angegebenen nullbasierten Index aus der Liste zurück.

objectbound Isom.Services.AsamParameter Isom.Services.AsamParameterList.At  ( Isom.Base.Number  index  ) 

Liefert den Parameter am angegebenen nullbasierten Index aus der Liste zurück.

 AsamParameterList paramList = AsamParameterList.CreateAsamParameterList(); 
 AsamParameter param0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 AsamParameter param1 = AsamParameter.CreateSimple("TEST1", "INT32", "-42"); 
 paramList.Insert(subParam0); 
 paramList.Insert(subParam1); 
 AsamParameter secondParam = paramList.At(1); // secondParam ist subParam1 
Parameter:
index  Index des abgerufenen Elements in der Liste, beginnend bei 0 für das erste Element.
Rückgabe:
Parameter mit dem übergebenen Index.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Index kleiner als 0 oder größer gleich der Anzahl der Listenelemente (=Anzahl der Parameter) ist.
Isom.Services.AsamParameterList.Clone

Erzeugt eine Kopie dieses Objekts.

objectbound Isom.Services.AsamParameterList Isom.Services.AsamParameterList.Clone  (  ) 

Erzeugt eine Kopie dieses Objekts.

Rückgabe:
Neue AsamParameterList mit demselben Inhalt.
Isom.Services.AsamParameterList.Contains

Prüft, ob ein Parameter mit dem angegebenen Namen in der Liste enthalten ist.

objectbound Isom.Base.Boolean Isom.Services.AsamParameterList.Contains  ( Isom.Base.String  name  ) 

Prüft, ob ein Parameter mit dem angegebenen Namen in der Liste enthalten ist.

 AsamParameterList paramList = AsamParameterList.CreateAsamParameterList(); 
 AsamParameter subParam0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 AsamParameter subParam1 = AsamParameter.CreateSimple("TEST1", "INT32", "7653"); 
 paramList.Insert(subParam0); // Liste enthält subParam0 
 paramList.Insert(subParam1); // Liste enthält subParam0, subParam 1 
 Boolean isContained = paramList.Contains("TEST0"); // isContained ist "true" 
Parameter:
name  Name des Parameters.
Rückgabe:
'true', falls das Element enthalten ist, 'false' sonst (z.B. wenn der Name das Void-Objekt ist oder kein Parameter dieses Namens bekannt ist).
Isom.Services.AsamParameterList.CreateAsamParameterList

Erzeugt eine neue Listeninstanz.

Isom.Services.AsamParameterList Isom.Services.AsamParameterList.CreateAsamParameterList  (  ) 

Erzeugt eine neue Listeninstanz.

 AsamParameterListList paramList = AsamParameterList.CreateAsamParameterList(); 
Rückgabe:
Die neu erzeugte ASAM-Parameterliste.
Isom.Services.AsamParameterList.Current

Liefert während des Durchlaufens der Liste den aktuellen Parameter

objectbound Isom.Services.AsamParameter Isom.Services.AsamParameterList.Current  (  ) 

Liefert während des Durchlaufens der Liste den aktuellen Parameter

 AsamParameterList paramList = ... 
 paramList.Reset();                        //Listendurchlauf vorbereiten 
 while (paramList.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    paramList.Next(); 
    AsamParameter param = paramList.Current();     //Element abrufen 
    ... 
 } 
Rückgabe:
Aktueller Parameter aus der Liste.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Durchlauf-Iterator vor das erste Element der Liste zeigt.
Isom.Services.AsamParameterList.Get

Ruft einen benannten Parameter aus der Liste ab.

objectbound Isom.Services.AsamParameter Isom.Services.AsamParameterList.Get  ( Isom.Base.String  name  ) 

Ruft einen benannten Parameter aus der Liste ab.

 AsamParameterList paramList = AsamParameterList.CreateAsamParameterList(); 
 AsamParameter param = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 paramList.Insert(param); 
 AsamParameter namedParam = paramList.Get("TEST0"); 
Parameter:
name  Name des abzurufenden Parameters.
Rückgabe:
Parameter mit dem übergebenen Namen.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls kein Parameter mit diesem Namen enthalten ist.
Isom.Services.AsamParameterList.HasNext

Prüft, ob es beim Durchlaufen der Liste mit .Next() Elemente gibt, die noch nicht abgerufen wurden.

objectbound Isom.Base.Boolean Isom.Services.AsamParameterList.HasNext  (  ) 

Prüft, ob es beim Durchlaufen der Liste mit .Next() Elemente gibt, die noch nicht abgerufen wurden.

 AsamParameterList paramList = ... 
 paramList.Reset();                        //Listendurchlauf vorbereiten 
 while (paramList.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    AsamParameter param = paramList.Next();     //Element abrufen und Durchlauf weiterführen 
    ... 
 } 
Rückgabe:
'true', falls noch weitere Parameter in der Liste mit .Next() abgerufen werden können, 'false' sonst.
Isom.Services.AsamParameterList.Insert

Fügt der Liste ein Element hinzu.

objectbound Isom.Base.Number Isom.Services.AsamParameterList.Insert  ( Isom.Services.AsamParameter  element  ) 

Fügt der Liste ein Element hinzu.

Das Element wird an der letzten Position der Liste eingefügt. Ein eventuell aktiver Iterator, wird durch diese Operation zurückgesetzt.

 AsamParameterList paramList = AsamParameterList.CreateAsamParameterList(); 
 AsamParameter param = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 paramList.Insert(param); 
Zu beachten:
Der zurückgegebene Index des eingefügten Elements ist nur gültig, solange kein Element an einer Position mit einem kleineren Index aus der Liste entfernt wird.
Parameter:
element  Hinzuzufügender Parameter.
Rückgabe:
Isom.Base.Number
Aktueller Index des eingefügten Elements in der Liste.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls das Element nicht hinzugefügt werden konnte.
Isom.Services.AsamParameterList.IsEmpty

Prüft, ob die Liste Elemente enthält

objectbound Isom.Base.Boolean Isom.Services.AsamParameterList.IsEmpty  (  ) 

Prüft, ob die Liste Elemente enthält

 AsamParameterList paramList = AsamParameterList.CreateAsamParameterList(); 
 AsamParameter param0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 Boolean isEmpty = paramList.IsEmpty(); // isEmpty ist "true" 
 paramList.Insert(subParam0); 
 Boolean isEmpty = paramList.IsEmpty(); // isEmpty ist "false" 
Rückgabe:
'true', falls die Liste Elemente enthält, 'false' sonst.
Isom.Services.AsamParameterList.IsVoid

Prüft, ob es sich um das Void-Objekt handelt.

objectbound Isom.Base.Boolean Isom.Services.AsamParameterList.IsVoid  (  ) 

Prüft, ob es sich um das Void-Objekt handelt.

Rückgabe:
'true', falls das Objekt Void ist, 'false' sonst.
Isom.Services.AsamParameterList.Length

Liefert die Anzahl der Parameter.

objectbound Isom.Base.Number Isom.Services.AsamParameterList.Length  (  ) 

Liefert die Anzahl der Parameter.

 AsamParameterList paramList = AsamParameterList.CreateAsamParameterList(); 
 AsamParameter param0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 AsamParameter param1 = AsamParameter.CreateSimple("TEST1", "INT32", "-42"); 
 paramList.Insert(subParam0); 
 paramList.Insert(subParam1); 
 Number length = paramList.Length(); // length ist 2 
Rückgabe:
Anzahl der Elemente.
Isom.Services.AsamParameterList.Next

Liefert beim Durchlaufen der Liste den nächsten Parameter.

objectbound Isom.Services.AsamParameter Isom.Services.AsamParameterList.Next  (  ) 

Liefert beim Durchlaufen der Liste den nächsten Parameter.

Ein Listendurchlauf wird mit .Reset() zurückgesetzt, um mit .Next() vom Listenanfang an durchlaufen zu können.

 AsamParameterList paramList = ... 
 paramList.Reset();                        //Listendurchlauf vorbereiten 
 while (paramList.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    AsamParameter param = paramList.Next();     //Element abrufen und Durchlauf weiterführen 
    ... 
 } 
Rückgabe:
Nächster Parameter aus der Liste.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls keine weiteren Elemente in der Liste sind.
Isom.Services.AsamParameterList.Remove

Entfernt den Parameter mit dem angegebenen Index aus der Liste Ein eventuell aktiver Durchlauf-Iterator wird durch diese Operation zurückgesetzt.

objectbound Isom.Base.Boolean Isom.Services.AsamParameterList.Remove  ( Isom.Base.Number  index  ) 

Entfernt den Parameter mit dem angegebenen Index aus der Liste Ein eventuell aktiver Durchlauf-Iterator wird durch diese Operation zurückgesetzt.

 AsamParameterList paramList = AsamParameterList.CreateAsamParameterList(); 
 AsamParameter subParam0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 AsamParameter subParam1 = AsamParameter.CreateSimple("TEST1", "INT32", "7653"); 
 paramList.Insert(subParam0); // Liste enthält subParam0 
 paramList.Insert(subParam1); // Liste enthält subParam0, subParam 1 
 paramList.Remove(0); // Liste enthält subParam1 
Rückgabe:
'true', falls das Element entfernt werden konnte, 'false' sonst (z.B. wenn der Index das Void-Objekt ist oder außerhalb des zulässigen Bereichs liegt).
Isom.Services.AsamParameterList.RemoveByName

Entfernt den Parameter mit dem angegebenen Namen aus der Liste eines Parameters.

objectbound Isom.Base.Boolean Isom.Services.AsamParameterList.RemoveByName  ( Isom.Base.String  name  ) 

Entfernt den Parameter mit dem angegebenen Namen aus der Liste eines Parameters.

Ein eventuell aktiver Durchlauf-Iterator wird durch diese Operation zurückgesetzt.

 AsamParameterList paramList = AsamParameterList.CreateAsamParameterList(); 
 AsamParameter subParam0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 AsamParameter subParam1 = AsamParameter.CreateSimple("TEST1", "INT32", "7653"); 
 paramList.Insert(subParam0); // Liste enthält subParam0 
 paramList.Insert(subParam1); // Liste enthält subParam0, subParam 1 
 paramList.RemoveByName("TEST0"); // Liste enthält subParam1 
Parameter:
name  Name des zu entfernenden Parameters.
Rückgabe:
'true', falls das Element entfernt werden konnte, 'false' sonst (z.B. wenn der Name das Void-Objekt ist oder kein Parameter dieses Namens bekannt ist).
Isom.Services.AsamParameterList.Reset

Setzt den Durchlauf-Iterator vor das erste Element der Liste von Parametern, so dass ein neuer Durchlauf der Liste begonnen werden kann.

objectbound Isom.Base.Boolean Isom.Services.AsamParameterList.Reset  (  ) 

Setzt den Durchlauf-Iterator vor das erste Element der Liste von Parametern, so dass ein neuer Durchlauf der Liste begonnen werden kann.

 AsamParameterList paramList = ... 
 paramList.Reset();                        //Listendurchlauf vorbereiten 
 while (paramList.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    AsamParameter param = paramList.Next();     //Element abrufen und Durchlauf weiterführen 
    ... 
 } 
Rückgabe:
Immer 'true'.
Isom.Services.AsamParameterList.Void

Erzeugt ein ungültiges Objekt.

Isom.Services.AsamParameterList Isom.Services.AsamParameterList.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