Referenzdepot für C#-APIs

Die APIs werden von der Klasse
IUANode
 bereitgestellt. Die Klasseninstanzen sind Ausgangspunkte für die Suche nach Knoten für die Rückgabe.
WICHTIG: Wenn mehrere Knoten denselben Namen haben, wird u. U. ein unerwünschter Knoten zurückgegeben.
TIPP:
In Visual Studio und Visual Studio Code wird durch Angabe des genauen Typs (
<T>
) die Vervollständigung des intelligenten Codes verbessert und es einfacher, Fehler beim Schreiben des Codes zu erkennen.
Zur Laufzeit ist ersichtlich, ob der gesuchte Knoten den gewünschten Typ hat. Wenn der gesuchte Knoten nicht den angeforderten Typ hat, gibt die API
null
 zurück.
Die APIs werden von der Klasse
InformationModel
 bereitgestellt, die vom Modul
FTOptix.HMIProject
 angezeigt wird.
TIPP: Zur Entwurfszeit funktioniert die API nur, wenn der angegebene Typ ein vordefinierter (in den FTOptix-Modulen enthaltener) Typ ist.
TIPP: Standardmäßig sind die in einer NetLogic definierten dynamischen Links schreibgeschützt. Die mit der
FactoryTalk Optix Studio
-Benutzeroberfläche erstellten dynamischen Links hingegen können sowohl gelesen als auch geschrieben werden.

Argumente

browsePath
 (string)
Kann eines der Folgenden sein:
  • Der
    BrowseName
     des Objekts
  • Der Pfad des Objekts im Informationsmodell, der eindeutig als Sequenz von durch
    /
     getrennten
    BrowseName
    -Werten ausgedrückt wird
T
Eine C#-Klasse von
IUANode
, die der Klasse des zurückzugebenden C#-Objekts entspricht.
IUANode
Eine C#-Klasse, die der Klasse des zurückzugebenden C#-Objekts entspricht.
aliasName
 (string)
Kann eines der Folgenden sein:
  • Der
    BrowseName
     des Alias
  • Der Pfad zum Knoten im Informationsmodell, der eindeutig als Sequenz von durch
    /
     getrennten
    BrowseName
    n ausgedrückt wird
browseName
 (string)
Der
BrowseName
 des zu findenden Knotens.
T
Eine C#-Klasse von IUANode, die der Klasse des zurückzugebenden C#-Objekts entspricht
child
 (IUANode)
Ein C#-Objekt, das dem hinzuzufügenden Projektknoten entspricht
browseName
 (QualifiedName)
Der
BrowseName
 des neuen Objekts.
objectTypeId
 (NodeId)
Die
NodeID
 des Typs, von dem das neue Objekt abgeleitet ist
superTypeId
 (NodeId)
Die
NodeID
 des Typs, von dem das neue Objekt abgeleitet ist
browseName
 (QualifiedName)
Der
BrowseName
 der neuen Variable.
dataTypeId
 (NodeId)
Der in der neuen Variable enthaltene Datentyp.
TIPP: Ein Knoten innerhalb der Klasse
DataTypes
 repräsentiert den Datentyp. Beispiel:
OpcUa.DataTypes.Boolean
.
browseName
 (QualifiedName)
Der
BrowseName
 des neuen Variablentyps.
arrayDimensions
 (uint[ ])
Optional. Die Größe des Arrays.
variableTypeId
 (NodeId)
Der Variablentyp, von dem der neue Variablentyp abgeleitet ist.
TIPP: Ein Knoten innerhalb der Klasse
VariableTypes
 repräsentiert den Datentyp. Beispiel:
FTOptix.CoDeSys.VariableTypes.Tag
.
dataTypeId
 (NodeId)
Der im neuen Variablentyp enthaltene Datentyp.
TIPP: Ein Knoten innerhalb der Klasse
DataTypes
 repräsentiert den Datentyp. Beispiel:
OpcUa.DataTypes.Boolean
.
timeoutMilliseconds
 (double)
Die Timeout-Zeitdauer in Millisekunden, nach deren Ablauf die API eine Ausnahme erzeugt.
TIPP: Wenn keine Angabe erfolgt, ist der Standardwert des Arguments
30000
 (30 Sekunden).
variables
 (IUAVariable)
Das C#-Objekt
IUAVariable
, das dem Objekt hinzugefügt werden soll, für das die Methode aufgerufen wird.
variables
 (RemoteVariable)
Das C#-Objekt
RemoteVariable
, das die Zelle eines ein- oder mehrdimensionalen Arrays bestimmt, die dem Objekt hinzugefügt werden soll, für das die Methode aufgerufen wird.
variables
 (IEnumerable<IUAVariable>)
Die Liste der
IUAVariable
, die dem Objekt hinzugefügt werden soll, aus dem die Methode aufgerufen wird.
variables
 (IEnumerable<RemoteVariable>)
Die Liste der
RemoteVariable
, die dem Objekt hinzugefügt werden soll, aus dem die Methode aufgerufen wird.
message
 (string)
Die zu generierende Meldung.
category
 (string)
Die Kategorie der Meldung.
source
 (IUAVariable)
Der
BrowseName
 der Quellvariable.
mode
 (DynamicLinkMode)
Ein optionales Argument für die Angabe des dynamischen Link-Modus.
Die folgenden dynamischen Link-Modi sind verfügbar:
DynamicLinkMode.Read
 (default)
Lesen (vom Quellknoten zum übergeordneten Element)
DynamicLinkMode.Write
Schreiben (vom übergeordneten Element zum Quellknoten)
DynamicLinkMode.ReadWrite
Lesen und Schreiben (bidirektional)
ResourceURI
Ein C#-Objekt, das den im Argument angegebenen Pfad enthält
localizedText
 (LocalizedText)
Ein C#-Objekt, dessen Eigenschaften
TextId
 und
NamespaceIndex
 den relevanten Schlüssel identifizieren
childVariableValues
 (IEnumerable)
Die Liste der Variablen, deren Wert geschrieben werden soll, ausgedrückt als Paar der folgenden Eigenschaften der Klasse
RemoteChildVariableValue
:
RelativePath
 (string)
Der relative Pfad zur Variablen innerhalb des Knotens.
Value
 (UAValue)
Der Wert der Variable.

Rückgabewert

T
Ein C#-Objekt, das mit dem angeforderten Knoten übereinstimmt.
IUANode
Ein C#-Objekt, das mit dem angeforderten Knoten übereinstimmt.
IUANode
Ein C#-Objekt, das dem gefundenen Objekt entspricht.
T
Ein C#-Objekt, das dem gefundenen Knoten entspricht.
IUAObject
Ein C#-Objekt, das dem erstellten Projektobjekt entspricht.
T
Ein C#-Objekt, das dem erstellten Projektobjekt entspricht.
IUAVariable
Ein C#-Objekt, das der erstellten Projektvariable entspricht.
IUAVariableType
Ein C#-Objekt, das dem erstellten Projektvariablentyp entspricht.

CSV-Eigenschaften

FieldDelimiter
Das für die Abgrenzung der Spalten verwendete Zeichen. Wenn diese Eigenschaft nicht angegeben ist, wird als Wert standardmäßig das Kommazeichen (
,
) verwendet.
public char FieldDelimiter { get; set; } = ',';
QuoteChar
Das zum Einschließen des Inhalts der einzelnen Felder verwendete Zeichen, wodurch das Zeichen
FieldDelimiter
 bei Bedarf im Inhalt eines Felds verwendet werden kann. Wenn diese Eigenschaft nicht angegeben ist, wird als Wert standardmäßig das doppelte Anführungszeichen (
"
) verwendet.
public char QuoteChar { get; set; } = '"';
Rückmeldung geben
Haben Sie Fragen oder Feedback zu dieser Dokumentation? Bitte geben Sie hier Ihr Feedback ab.