Isom.Services.AsamParameter

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

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Services.AsamParameter

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.AsamParameter.At

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

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

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

 AsamParameter param = AsamParameter.CreateComplex("MUX_NAME", "MULTIPLEXER"); 
 AsamParameter subParam = AsamParameter.CreateSimple("TEST", "UINT32", "5"); 
 param.Insert(subParam); 
 AsamParameter firstSubParam = param.At(0);            // firstSubParam ist subParam 
 AsamParameter secondSubParam = param.At(1);           // secondSubParam ist Void 
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 Unterparameter) ist, oder der Parameter ein einfacher Parameter ist.
Isom.Services.AsamParameter.Clone

Erzeugt eine Kopie dieses Objekts.

objectbound Isom.Services.AsamParameter Isom.Services.AsamParameter.Clone  (  ) 

Erzeugt eine Kopie dieses Objekts.

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

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

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

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

 AsamParameter param = ... 
 AsamParameter subParam0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 param.Insert(subParam0); 
 Boolean contained = param.Contains("TEST0"); // contained ist true 
Parameter:
name  Name des Unterparameters.
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).
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Aufruf auf einem einfachen Parameter erfolgt.
Isom.Services.AsamParameter.Create

Erzeugt einen benannten ASAM-Parameter ohne Typinformation oder Wert.

Isom.Services.AsamParameter Isom.Services.AsamParameter.Create  ( Isom.Base.String  name  ) 

Erzeugt einen benannten ASAM-Parameter ohne Typinformation oder Wert.

 AsamParameter param = AsamParameter.Create("PARAMETER_NAME"); 
Rückgabe:
Der neu erzeugte ASAM-Parameter.
Isom.Services.AsamParameter.CreateComplex

Erzeugt einen komplexen ASAM-Parameter.

Isom.Services.AsamParameter Isom.Services.AsamParameter.CreateComplex  ( Isom.Base.String  name,
Isom.Base.String  dataType  )

Erzeugt einen komplexen ASAM-Parameter.

 AsamParameter param = AsamParameter.CreateSimple("COMPLEX_PARAMETER_NAME", "MULTIPLEXER"); 
Parameter:
name  Name des ASAM-Parameters
dataType  ASAM-Datentyp des Parameters; erlaubte Werte für diese Zeichenkette sind:
  • "DTC"
  • "END_OF_PDU"
  • "ENVDATA"
  • "ENVDATADESC"
  • "FIELD"
  • "MULTIPLEXER"
  • "STRUCTURE"
  • "TABLE"
  • "TEXTTABLE"
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der angegebene Datentyp ungültig ist oder sich der angebene Wert nicht in den Datentyp konvertiert werden kann.
Rückgabe:
Der neu erzeugte ASAM-Parameter
Isom.Services.AsamParameter.CreateSimple

Erzeugt einen einfachen ASAM-Parameter.

Isom.Services.AsamParameter Isom.Services.AsamParameter.CreateSimple  ( Isom.Base.String  name,
Isom.Base.String  dataType,
Isom.Base.String  value  )

Erzeugt einen einfachen ASAM-Parameter.

 AsamParameter param = AsamParameter.CreateSimple("SIMPLE_PARAMETER_NAME", "UINT32", "42"); 
Parameter:
name  Name des ASAM-Parameters
dataType  ASAM-Datentyp des Parameters; erlaubte Werte für diese Zeichenkette sind:
  • "ASCIISTRING"
  • "BITFIELD"
  • "BOOLEAN"
  • "BYTEFIELD"
  • "FLOAT32"
  • "FLOAT64"
  • "INT16"
  • "INT32"
  • "INT64"
  • "INT8"
  • "KEY"
  • "LENGTHKEY"
  • "UINT16"
  • "UINT32"
  • "UINT64"
  • "UINT8"
  • "UNICODE2STRING"
value  Wert des Parameters
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der angegebene Datentyp ungültig ist oder sich der angebene Wert nicht in den Datentyp konvertiert werden kann.
Rückgabe:
Der neu erzeugte ASAM-Parameter
Isom.Services.AsamParameter.Current

Liefert während des Durchlaufens der Liste den aktuellen Unterparameter

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

Liefert während des Durchlaufens der Liste den aktuellen Unterparameter

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

Ruft einen benannten Unterparameter des Parameters ab.

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

Ruft einen benannten Unterparameter des Parameters ab.

 AsamParameter param = ... 
 AsamParameter subParam = param.Get("SUB_PARAM_NAME"); 
Parameter:
name  Name des abzurufenden Unterparameters.
Rückgabe:
Parameter mit dem übergebenen Namen.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls kein Unterparameter mit diesem Namen enthalten ist oder der Parameter ein einfacher Parameter ist.
Isom.Services.AsamParameter.GetDataType

Ruft den aktuellen ASAM-Datentyp des Parameters ab.

objectbound Isom.Base.String Isom.Services.AsamParameter.GetDataType  (  ) 

Ruft den aktuellen ASAM-Datentyp des Parameters ab.

 AsamParameter param = ... 
 String dataType = param.GetDataType(); 
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Typ des Parameters unbekannt ist.
Achtung:
Nicht alle D-Server-Implementierungen können diese Information anbieten, falls es sich um einen Rückgabeparameter eines ASAM-Aufrufs handelt. In diesem Fall wird das Void-Objekt zurückgegeben.
Rückgabe:
Der aktuelle ASAM-Datentyp des Parameters als Zeichenkette.
Isom.Services.AsamParameter.GetName

Ruft den Namen des Parameters ab.

objectbound Isom.Base.String Isom.Services.AsamParameter.GetName  (  ) 

Ruft den Namen des Parameters ab.

 AsamParameter param = ... 
 String paramName = param.GetName(); 
Rückgabe:
Der Name des Parameters
Isom.Services.AsamParameter.GetValue

Ruft den Wert des Parameters ab.

objectbound Isom.Base.String Isom.Services.AsamParameter.GetValue  (  ) 

Ruft den Wert des Parameters ab.

Achtung:
Der Wert eines komplexen Parameters ist die Anzahl seiner Unterparameter.
 AsamParameter param = ... 
 String val = param.GetValue(); 
Rückgabe:
Der Wert des Parameters
Isom.Services.AsamParameter.HasNext

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

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

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

 AsamParameter param = ... 
 param.Reset();                        //Listendurchlauf vorbereiten 
 while (param.HasNext ())              //Prüfen, ob es ein nächstes Element gibt 
 { 
    AsamParameter currentSubParam = param.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.AsamParameter.Insert

Fügt einem Parameter einen Unterparameter hinzu.

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

Fügt einem Parameter einen Unterparameter hinzu.

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

 AsamParameter param = AsamParameter.CreateComplex("MUX_NAME", "MULTIPLEXER"); 
 AsamParameter subParam = AsamParameter.CreateSimple("TEST", "UINT32", "5"); 
 param.Insert(subParam); 
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 Unterparameter.
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.
Es wird das Void-Objekt zurückgegeben, falls der Aufruf auf einem einfachen Parameter erfolgt.
Isom.Services.AsamParameter.IsComplex

Bestimmt, ob es sich um einen komplexen Parameter handelt.

objectbound Isom.Base.Boolean Isom.Services.AsamParameter.IsComplex  (  ) 

Bestimmt, ob es sich um einen komplexen Parameter handelt.

 AsamParameter param = ... 
 Boolean isComplex = param.IsComplex(); 
Rückgabe:
"True" genau dann, wenn es sich um einen komplexen Parameter handelt.
Isom.Services.AsamParameter.IsEmpty

Prüft, ob dieser Parameter Unterparameter enthält oder nicht.

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

Prüft, ob dieser Parameter Unterparameter enthält oder nicht.

 AsamParameter param = AsamParameter.CreateComplex("MUX_NAME", "MULTIPLEXER"); 
 Boolean isEmpty = param.IsEmpty();    // isEmpty ist true 
 AsamParameter subParam = AsamParameter.CreateSimple("TEST", "UINT32", "5"); 
 param.Insert(subParam); 
 isEmpty = param.IsEmpty();            // isEmpty ist false 
Rückgabe:
'true', falls dieser Parameter Unterparameter enthält, 'false' sonst.
Isom.Services.AsamParameter.IsVoid

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

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

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

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

Liefert die Anzahl der Unterparameter.

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

Liefert die Anzahl der Unterparameter.

 AsamParameter param = AsamParameter.CreateComplex("MUX_NAME", "MULTIPLEXER"); 
 AsamParameter subParam0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 AsamParameter subParam1 = AsamParameter.CreateSimple("TEST1", "INT32", "7653"); 
 param.Insert(subParam0); 
 param.Insert(subParam1); 
 Number length = param.Length(); // length ist 2 
Rückgabe:
Anzahl der Elemente.
Isom.Services.AsamParameter.Next

Liefert beim Durchlaufen der Liste den nächsten Unterparameter.

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

Liefert beim Durchlaufen der Liste den nächsten Unterparameter.

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

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

Entfernt den Unterparameter mit dem angegebenen Index aus der Liste eines Parameters.

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

Entfernt den Unterparameter mit dem angegebenen Index aus der Liste eines Parameters.

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

 AsamParameter param = ... 
 AsamParameter subParam0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 AsamParameter subParam1 = AsamParameter.CreateSimple("TEST1", "INT32", "7653"); 
 param.Insert(subParam0); // Liste enthält subParam0 
 param.Insert(subParam1); // Liste enthält subParam0, subParam 1 
 param.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).
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Aufruf auf einem einfachen Parameter erfolgt.
Isom.Services.AsamParameter.RemoveByName

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

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

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

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

 AsamParameter param = ... 
 AsamParameter subParam0 = AsamParameter.CreateSimple("TEST0", "UINT32", "5"); 
 AsamParameter subParam1 = AsamParameter.CreateSimple("TEST1", "INT32", "7653"); 
 param.Insert(subParam0); // Liste enthält subParam0 
 param.Insert(subParam1); // Liste enthält subParam0, subParam 1 
 param.Remove("TEST0"); // Liste enthält subParam1 
Parameter:
name  Name des zu entfernenden Unterparameters.
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).
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Aufruf auf einem einfachen Parameter erfolgt.
Isom.Services.AsamParameter.Reset

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

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

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

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

Setzt den aktuellen ASAM-Datentyp des Parameters.

objectbound Isom.Base.Boolean Isom.Services.AsamParameter.SetDataType  ( Isom.Base.String  dataType  ) 

Setzt den aktuellen ASAM-Datentyp des Parameters.

 AsamParameter param = ... 
 Boolean success = param.SetDataType("ASCIISTRING"); 
  • "ASCIISTRING"
  • "BITFIELD"
  • "BOOLEAN"
  • "BYTEFIELD"
  • "DTC"
  • "END_OF_PDU"
  • "ENVDATA"
  • "ENVDATADESC"
  • "FIELD"
  • "FLOAT32"
  • "FLOAT64"
  • "INT16"
  • "INT32"
  • "INT64"
  • "INT8"
  • "KEY"
  • "LENGTHKEY"
  • "MULTIPLEXER"
  • "STRUCTURE"
  • "TABLE"
  • "TEXTTABLE"
  • "UINT16"
  • "UINT32"
  • "UINT64"
  • "UINT8"
  • "UNICODE2STRING"
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls der Typ des Parameters unbekannt ist.
Rückgabe:
"True" genau dann, wenn das Setzen des Typs erfolgreich war.
Isom.Services.AsamParameter.SetName

Setzt den Namen des Parameters.

objectbound Isom.Base.String Isom.Services.AsamParameter.SetName  ( Isom.Base.String  name  ) 

Setzt den Namen des Parameters.

 AsamParameter param = ... 
 String newName = param.SetName("NEW_PARAM_NAME"); 
Parameter:
name  Der zu setzende Name des Parameters
Rückgabe:
Der aktuell gesetzte Name des Parameters
Isom.Services.AsamParameter.SetValue

Setzt den Wert eines einfachen Parameters.

objectbound Isom.Base.Boolean Isom.Services.AsamParameter.SetValue  ( Isom.Base.String  val  ) 

Setzt den Wert eines einfachen Parameters.

Achtung:
Der Wert eines komplexen Parameters kann nicht gesetzt werden.
 AsamParameter param = ... 
 Boolean success = param.SetValue("42"); 
Parameter:
val  Der zu setzende Wert des Parameters
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls es sich um einen komplexen Parameter handelt oder der angebene Wert nicht in den aktuellen Datentyp des Parameters konvertiert werden kann.
Rückgabe:
"True" genau dann, wenn das Setzen des Werts erfolgreich war.
Isom.Services.AsamParameter.Void

Erzeugt ein ungültiges Objekt.

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