C# APIs reference Warehouse

The APIs are supplied by the
IUANode
 class. The class instances are starting points for searching the nodes to return.
IMPORTANT: If multiple nodes have the same name, an unwanted node may be returned.
TIP:
In Visual Studio and Visual Studio Code, specifying the exact type (
<T>
) improves the intelligent code completion and makes it easier to identify errors while writing the code.
At runtime, it is evident if the node searched is of the requested type. If the searched node is not of the requested type, the API returns
null
.
The APIs are supplied by the
InformationModel
 class, displayed by the
FTOptix.HMIProject
 module.
TIP: At design time, the API functions only if the specified type is a predefined type (contained in the FTOptix modules).
TIP: By default, dynamic links defined in a NetLogic are read-only, whereas dynamic links created with the
FactoryTalk Optix Studio
 UI are read and write.

Arguments

browsePath
 (string)
Can be either:
  • The
    BrowseName
     of the object
  • The path of the object in the information model, uniquely expressed as a sequence of
    BrowseName
     values separated by
    /
T
An
IUANode
 C# class that corresponds to the class of the C# object to return.
IUANode
A C# class that corresponds to the class of the C# object to return.
aliasName
 (string)
Can be either:
  • The
    BrowseName
     of the Alias
  • The path to the node in the information model, uniquely expressed as a sequence of
    BrowseName
    s separated by
    /
browseName
 (string)
The
BrowseName
 of the node to find.
T
A IUANode C# class that corresponds to the C# object class to return.
child
 (IUANode)
A C# object that corresponds to the project node to add.
browseName
 (QualifiedName)
The
BrowseName
 of the new object.
objectTypeId
 (NodeId)
The
NodeID
 of the type from which the new object is derived.
superTypeId
 (NodeId)
The
NodeID
 of the type from which the new object is derived.
browseName
 (QualifiedName)
The
BrowseName
 of the new variable.
dataTypeId
 (NodeId)
The Data type contained in the new variable.
TIP: The Data type is represented by a node inside the
DataTypes
 classes. For example,
OpcUa.DataTypes.Boolean
.
browseName
 (QualifiedName)
The
BrowseName
 of the new variable type.
arrayDimensions
 (uint[ ])
Optional. The size of the Array.
variableTypeId
 (NodeId)
The Variable type from which the new variable type is derived.
TIP: The Data type is represented by a node inside the
VariableTypes
 classes. For example,
FTOptix.CoDeSys.VariableTypes.Tag
.
dataTypeId
 (NodeId)
The Data type contained in the new variable type.
TIP: The Data type is represented by a node inside the
DataTypes
 classes. For example,
OpcUa.DataTypes.Boolean
.
timeoutMilliseconds
 (double)
The timeout period, expressed in milliseconds, after which the API throws an exception.
TIP: If not specified, the default value of the argument is
30000
 (30 seconds).
variables
 (IUAVariable)
The
IUAVariable
 C# object to add to the object on which the method is invoked.
variables
 (RemoteVariable)
The
RemoteVariable
 C# object that identifies a cell of a one-dimensional or multidimensional array to be added to the object on which the method is invoked.
variables
 (IEnumerable<IUAVariable>)
The
IUAVariable
 list to be added to the object on which the method is invoked.
variables
 (IEnumerable<RemoteVariable>)
The
RemoteVariable
 list to be added to the object on which the method is invoked.
message
 (string)
The message to generate.
category
 (string)
The message category.
source
 (IUAVariable)
The
BrowseName
 of the source variable.
mode
 (DynamicLinkMode)
An optional argument that specifies the dynamic link mode.
The following dynamic link modes are available:
DynamicLinkMode.Read
 (default)
Read (from source node to parent).
DynamicLinkMode.Write
Write (from parent to source).
DynamicLinkMode.ReadWrite
Read and write (bidirectional).
ResourceURI
A C# object that contains the path indicated in the argument.
localizedText
 (LocalizedText)
A C# object that
TextId
 and
NamespaceIndex
 properties identify the key of interest.
childVariableValues
 (IEnumerable)
The list of the variables whose value we want to write, expressed as a pair of the
RemoteChildVariableValue
 class following properties:
RelativePath
 (string)
The path relative to the variable inside the node.
Value
 (UAValue)
The value of the variable.

Returns

T
A C# object that matches the requested node.
IUANode
A C# object that matches the requested node.
IUANode
A C# object that corresponds to the object found.
T
A C# object that corresponds to the node found.
IUAObject
A C# object that corresponds to the project object created.
T
A C# object that corresponds to the project object created.
IUAVariable
A C# object that corresponds to the project variable created.
IUAVariableType
A C# object matching the project variable type created.

CSV Properties

FieldDelimiter
The character used to delimit the columns. If this property is not specified, its value defaults to the comma character (
,
). 
public char FieldDelimiter { get; set; } = ',';
QuoteChar
The character used to enclose the content of each field, which allows to use the
FieldDelimiter
 character in the content of a field if necessary. If this property is not specified, its value defaults to the double quotes character (
"
). 
public char QuoteChar { get; set; } = '"';
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.