Reference

OpcNodeSet Members

Type

OpcNodeSet

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

Context

since v2.50

Gets the OpcContext used for this OpcNodeSet.

public OpcContext Context { get; }

Public ReadOnly Property Context As OpcContext

Property value

OpcContext

A OpcContext used to create this OpcNodeSet or a null reference (Nothing in Visual Basic) if this OpcNodeSet has been created without any specific OpcContext.

LastModified

since v2.9

Gets the last time the node set document was modified.

public DateTime? LastModified { get; }

Public ReadOnly Property LastModified As Date?

Property value

Nullable<DateTime>

The last time the node set document was modified or a null reference (Nothing in Visual Basic) if there is no time of the last modification available.

Remarks

The value of this property is primarly determined by the contents of the node set document the current OpcNodeSet originates from. In case there the node set document does not provide the last modified information this property represents the LastWriteTime in case there the node set has been created from a file; otherwise a null reference (Nothing in Visual Basic).

Models

since v2.9

Gets a read-only collection of the models declared by the node set.

public OpcReadOnlyModelCollection Models { get; }

Public ReadOnly Property Models As OpcReadOnlyModelCollection

Property value

OpcReadOnlyModelCollection

An instance of the OpcReadOnlyModelCollection class with an OpcModel for each model declared by the current OpcNodeSet; empty if it declares no model.

Name

since v2.9

Gets the name of the node set.

public string Name { get; }

Public ReadOnly Property Name As String

Property value

String

The Name of the first model declared by the current OpcNodeSet (see Models). In case there it declares no model with a name and the OpcNodeSet has been created from a file, the name of the file without extension; otherwise a null reference (Nothing in Visual Basic).

Namespaces

since v2.9

Gets a read-only collection of OpcNamespaces referred to.

public OpcReadOnlyNamespaceCollection Namespaces { get; }

Public ReadOnly Property Namespaces As OpcReadOnlyNamespaceCollection

Property value

OpcReadOnlyNamespaceCollection

An instance of the OpcReadOnlyNamespaceCollection class with the OpcNamespace information used by the current OpcNodeSet.

Methods

GetDataType

6 overloads · since v2.9

Overload	Description
GetDataType(string)since v2.9	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetDataType(OpcName)since v2.9	Retrieves the OpcDataTypeInfo object which is known under the name specified.
GetDataType(OpcNodeId)since v2.9	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.
GetDataType(Type)since v2.9	Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.
GetDataType(OpcEncoding)since v2.9	Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.
GetDataType(XmlQualifiedName)since v2.9	Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.

GetDataType(string)

since v2.9

Retrieves the OpcDataTypeInfo object which is known under the name specified.

public OpcDataTypeInfo GetDataType(string name)

Public Function GetDataType(name As String) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentException	The name is equals Empty.
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetDataType(OpcName)

since v2.9

Retrieves the OpcDataTypeInfo object which is known under the name specified.

public OpcDataTypeInfo GetDataType(OpcName name)

Public Function GetDataType(name As OpcName) As OpcDataTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetDataType(OpcNodeId)

since v2.9

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the typeId specified.

public OpcDataTypeInfo GetDataType(OpcNodeId typeId)

Public Function GetDataType(typeId As OpcNodeId) As OpcDataTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo object which is associated with the typeId specified.

Exceptions

Exception	Condition
ArgumentNullException	The typeId is a null reference (Nothing in Visual Basic).

GetDataType(Type)

since v2.9

Retrieves the OpcDataTypeInfo object which declares the type implemented by the underlyingType specified.

public OpcDataTypeInfo GetDataType(Type underlyingType)

Public Function GetDataType(underlyingType As Type) As OpcDataTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcDataTypeInfo object associated with the underlyingType specified.

Exceptions

Exception	Condition
ArgumentNullException	The underlyingType is a null reference (Nothing in Visual Basic).

GetDataType(OpcEncoding)

since v2.9

Retrieves the OpcDataTypeInfo object which declares the type which is identified by the encoding specified.

public OpcDataTypeInfo GetDataType(OpcEncoding encoding)

Public Function GetDataType(encoding As OpcEncoding) As OpcDataTypeInfo

Parameters

Name	Type	Description
encoding	OpcEncoding	The OpcEncoding which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object which is known under the encoding specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcDataTypeInfo which is associated with the encoding specified.

Exceptions

Exception	Condition
ArgumentNullException	The encoding is a null reference (Nothing in Visual Basic).

GetDataType(XmlQualifiedName)

since v2.9

Retrieves the OpcDataTypeInfo object which is known under the xmlName specified.

public OpcDataTypeInfo GetDataType(XmlQualifiedName xmlName)

Public Function GetDataType(xmlName As XmlQualifiedName) As OpcDataTypeInfo

Parameters

Name	Type	Description
xmlName	XmlQualifiedName	The XmlQualifiedName of the OpcDataTypeInfo object to retrieve.

Returns

OpcDataTypeInfo

The OpcDataTypeInfo object its XmlName is equals to the xmlName specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The xmlName is a null reference (Nothing in Visual Basic).

GetDataTypes

since v2.9

Retrieves all OpcDataTypeInfo objects offered by the IOpcTypeProvider.

public OpcDataTypeInfo[] GetDataTypes()

Public Function GetDataTypes() As OpcDataTypeInfo()

Returns

OpcDataTypeInfo[]

An array that contains all OpcDataTypeInfo objects that are offered by the IOpcTypeProvider.

GetDataTypeSystem

2 overloads

Overload	Description
GetDataTypeSystem()	Retrieves the system used to describe the data types defined in the OpcNodeSet using Binary as the type of encoding.
GetDataTypeSystem(OpcEncodingType)	Retrieves the system used to describe the data types defined in the OpcNodeSet using OpcEncodingType specified by encodingType as the type of encoding.

GetDataTypeSystem()

Retrieves the system used to describe the data types defined in the OpcNodeSet using Binary as the type of encoding.

public OpcDataTypeSystem GetDataTypeSystem()

Public Function GetDataTypeSystem() As OpcDataTypeSystem

Returns

OpcDataTypeSystem

An instance of the OpcDataTypeSystem class which can be used to understand the structure of the data described for the Binary encoding.

GetDataTypeSystem(OpcEncodingType)

Retrieves the system used to describe the data types defined in the OpcNodeSet using OpcEncodingType specified by encodingType as the type of encoding.

public OpcDataTypeSystem GetDataTypeSystem(OpcEncodingType encodingType)

Public Function GetDataTypeSystem(
    encodingType As OpcEncodingType) As OpcDataTypeSystem

Parameters

Name	Type	Description
encodingType	OpcEncodingType

Returns

OpcDataTypeSystem

An instance of the OpcDataTypeSystem class which can be used to understand the structure of the data described for the encoding specified.

GetNode

since v2.50

Retrieves the IOpcNodeInfo which is defined within this OpcNodeSet and is known under the nodeId specified.

public IOpcNodeInfo GetNode(OpcNodeId nodeId)

Public Function GetNode(nodeId As OpcNodeId) As IOpcNodeInfo

Parameters

Name	Type	Description
nodeId	OpcNodeId	The OpcNodeId of the IOpcNodeInfo instance to determine.

Returns

IOpcNodeInfo

An instance implementing the IOpcNodeInfo interface its Id attribute is equals to the nodeId specified if found; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The nodeId is a null reference (Nothing in Visual Basic).

GetNodes

since v2.54

Retrieves a sequence of IOpcNodeInfo of all nodes defined within this OpcNodeSet.

public IEnumerable<IOpcNodeInfo> GetNodes()

Public Function GetNodes() As IEnumerable(Of IOpcNodeInfo)

Returns

IEnumerable<IOpcNodeInfo>

An IEnumerable<T> of instances implementing the IOpcNodeInfo interface.

GetNodeType

4 overloads · since v2.9

Overload	Description
GetNodeType(string)since v2.9	Retrieves the OpcNodeTypeInfo object which is known under the name specified.
GetNodeType(OpcName)since v2.9	Retrieves the OpcNodeTypeInfo object which is known under the name specified.
GetNodeType(OpcNodeId)since v2.9	Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.
GetNodeType(Type)since v2.9	Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

GetNodeType(string)

since v2.9

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

public OpcNodeTypeInfo GetNodeType(string name)

Public Function GetNodeType(name As String) As OpcNodeTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcNodeTypeInfo object to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentException	The name is equals Empty.
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetNodeType(OpcName)

since v2.9

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

public OpcNodeTypeInfo GetNodeType(OpcName name)

Public Function GetNodeType(name As OpcName) As OpcNodeTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcNodeTypeInfo object to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	The name is a null reference (Nothing in Visual Basic).

GetNodeType(OpcNodeId)

since v2.9

Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.

public OpcNodeTypeInfo GetNodeType(OpcNodeId typeId)

Public Function GetNodeType(typeId As OpcNodeId) As OpcNodeTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcNodeTypeInfo to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcNodeTypeInfo object which is associated with the typeId specified.

Exceptions

Exception	Condition
ArgumentNullException	The typeId is a null reference (Nothing in Visual Basic).

GetNodeType(Type)

since v2.9

Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

public OpcNodeTypeInfo GetNodeType(Type underlyingType)

Public Function GetNodeType(underlyingType As Type) As OpcNodeTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcNodeTypeInfo to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcNodeTypeInfo object associated with the underlyingType specified.

Exceptions

Exception	Condition
ArgumentNullException	The underlyingType is a null reference (Nothing in Visual Basic).

GetNodeTypes

since v2.9

Retrieves all OpcNodeTypeInfo objects offered by the IOpcTypeProvider.

public OpcNodeTypeInfo[] GetNodeTypes()

Public Function GetNodeTypes() As OpcNodeTypeInfo()

Returns

OpcNodeTypeInfo[]

An array that contains all OpcNodeTypeInfo objects that are offered by the IOpcTypeProvider.

GetNodeTypeSystem

since v2.9

Retrieves the system used to describe the node types defined in the OpcNodeSet.

public OpcNodeTypeSystem GetNodeTypeSystem()

Public Function GetNodeTypeSystem() As OpcNodeTypeSystem

Returns

OpcNodeTypeSystem

An instance of the OpcNodeTypeSystem class which can be used to understand the structure of the nodes defined.

Load

static · 6 overloads

Overload	Description
Load(string)static	Creates a new OpcNodeSet instance from the file specified by filePath.
Load(OpcContext, string)static · since v2.50	Creates a new OpcNodeSet instance within the context from the file specified by filePath.
Load(string, OpcNodeSetLoadOptions)static · since v2.40	Creates a new OpcNodeSet instance from the file specified by filePath using the further defined load options.
Load(OpcContext, string, OpcNodeSetLoadOptions)static · since v2.50	Creates a new OpcNodeSet instance within the context from the file specified by filePath using the further defined load options.
Load(Stream)static	Creates a new OpcNodeSet instance from the contents in the stream specified.
Load(OpcContext, Stream)static · since v2.50	Creates a new OpcNodeSet instance within the context from the contents in the stream specified.

Exceptions (all overloads)

Exception	Condition
InvalidDataException	The node set specified does not provide any namespace information.

Load(string)

static

Creates a new OpcNodeSet instance from the file specified by filePath.

public static OpcNodeSet Load(string filePath)

Public Shared Function Load(filePath As String) As OpcNodeSet

Parameters

Name	Type	Description
filePath	String	The path to the file from which the OpcNodeSet is to be created.

Returns

OpcNodeSet

A new instance of the OpcNodeSet class that represents the contents of the file.

Exceptions

Exception	Condition
ArgumentException	The filePath is an empty string.
ArgumentNullException	The filePath is a null reference (Nothing in Visual Basic).

Load(OpcContext, string)

static · since v2.50

Creates a new OpcNodeSet instance within the context from the file specified by filePath.

public static OpcNodeSet Load(OpcContext context, string filePath)

Public Shared Function Load(
    context As OpcContext,
    filePath As String) As OpcNodeSet

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to load the OpcNodeSet.
filePath	String	The path to the file from which the OpcNodeSet is to be created.

Returns

OpcNodeSet

A new instance of the OpcNodeSet class that represents the contents of the file.

Exceptions

Exception	Condition
ArgumentException	The filePath is an empty string.
ArgumentNullException	The context or filePath is a null reference (Nothing in Visual Basic).

Load(string, OpcNodeSetLoadOptions)

static · since v2.40

Creates a new OpcNodeSet instance from the file specified by filePath using the further defined load options.

public static OpcNodeSet Load(string filePath, OpcNodeSetLoadOptions options)

Public Shared Function Load(
    filePath As String,
    options As OpcNodeSetLoadOptions) As OpcNodeSet

Parameters

Name	Type	Description
filePath	String	The path to the file from which the OpcNodeSet is to be created.
options	OpcNodeSetLoadOptions	A combination of different OpcNodeSetLoadOptions to use to load the node-set file.

Returns

OpcNodeSet

A new instance of the OpcNodeSet class that represents the contents of the file.

Exceptions

Exception	Condition
ArgumentException	The filePath is an empty string.
ArgumentNullException	The filePath is a null reference (Nothing in Visual Basic).

Load(OpcContext, string, OpcNodeSetLoadOptions)

static · since v2.50

Creates a new OpcNodeSet instance within the context from the file specified by filePath using the further defined load options.

public static OpcNodeSet Load(
    OpcContext context,
    string filePath,
    OpcNodeSetLoadOptions options)

Public Shared Function Load(
    context As OpcContext,
    filePath As String,
    options As OpcNodeSetLoadOptions) As OpcNodeSet

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to load the OpcNodeSet.
filePath	String	The path to the file from which the OpcNodeSet is to be created.
options	OpcNodeSetLoadOptions	A combination of different OpcNodeSetLoadOptions to use to load the node-set file.

Returns

OpcNodeSet

A new instance of the OpcNodeSet class that represents the contents of the file.

Exceptions

Exception	Condition
ArgumentException	The filePath is an empty string.
ArgumentNullException	The context or filePath is a null reference (Nothing in Visual Basic).

Load(Stream)

static

Creates a new OpcNodeSet instance from the contents in the stream specified.

public static OpcNodeSet Load(Stream stream)

Public Shared Function Load(stream As Stream) As OpcNodeSet

Parameters

Name	Type	Description
stream	Stream	The Stream which contains the data from which the OpcNodeSet is to be created.

Returns

OpcNodeSet

A new instance of the OpcNodeSet class that represents the contents of the stream.

Exceptions

Exception	Condition
ArgumentNullException	The stream is a null reference (Nothing in Visual Basic).

Load(OpcContext, Stream)

static · since v2.50

Creates a new OpcNodeSet instance within the context from the contents in the stream specified.

public static OpcNodeSet Load(OpcContext context, Stream stream)

Public Shared Function Load(
    context As OpcContext,
    stream As Stream) As OpcNodeSet

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to load the OpcNodeSet.
stream	Stream	The Stream which contains the data from which the OpcNodeSet is to be created.

Returns

OpcNodeSet

A new instance of the OpcNodeSet class that represents the contents of the stream.

Exceptions

Exception	Condition
ArgumentNullException	The context or stream is a null reference (Nothing in Visual Basic).

Parse

static · 2 overloads

Overload	Description
Parse(string)static	Creates a new OpcNodeSet instance from the string specified by data.
Parse(OpcContext, string)static · since v2.50	Creates a new OpcNodeSet instance within the context from the string specified by data.

Exceptions (all overloads)

Exception	Condition
ArgumentException	The data is an empty string.
ArgumentNullException	The data is a null reference (Nothing in Visual Basic).
InvalidDataException	The node set specified does not provide any namespace information.

Parse(string)

static

Creates a new OpcNodeSet instance from the string specified by data.

public static OpcNodeSet Parse(string data)

Public Shared Function Parse(data As String) As OpcNodeSet

Parameters

Name	Type	Description
data	String	The string that contains the node set data.

Returns

OpcNodeSet

Parse(OpcContext, string)

static · since v2.50

Creates a new OpcNodeSet instance within the context from the string specified by data.

public static OpcNodeSet Parse(OpcContext context, string data)

Public Shared Function Parse(
    context As OpcContext,
    data As String) As OpcNodeSet

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to load the OpcNodeSet.
data	String	The string that contains the node set data.

Returns

OpcNodeSet

Save

2 overloads · since v2.11

Overload	Description
Save(string)since v2.11	Writes this OpcNodeSet as a node set XML document to the file specified by the filePath.
Save(Stream)since v2.11	Writes this OpcNodeSet as a node set XML document to the stream specified.

Save(string)

since v2.11

Writes this OpcNodeSet as a node set XML document to the file specified by the filePath.

public void Save(string filePath)

Public Sub Save(filePath As String)

Parameters

Name	Type	Description
filePath	String	The path to the file this OpcNodeSet is to be written to.

Exceptions

Exception	Condition
ArgumentException	The filePath is an empty string.
ArgumentNullException	The filePath is a null reference (Nothing in Visual Basic).

Remarks

An existing file is overwritten.

Save(Stream)

since v2.11

Writes this OpcNodeSet as a node set XML document to the stream specified.

public void Save(Stream stream)

Public Sub Save(stream As Stream)

Parameters

Name	Type	Description
stream	Stream	The Stream this OpcNodeSet is to be written to.

Exceptions

Exception	Condition
ArgumentNullException	The stream is a null reference (Nothing in Visual Basic).

TryParse

static · 2 overloads

Overload	Description
TryParse(string, out OpcNodeSet)static	Determines whether a string is a valid OpcNodeSet.
TryParse(OpcContext, string, out OpcNodeSet)static · since v2.50	Determines whether a string within the context is a valid OpcNodeSet.

TryParse(string, out OpcNodeSet)

static

Determines whether a string is a valid OpcNodeSet.

public static bool TryParse(string data, out OpcNodeSet nodeSet)

Public Shared Function TryParse(
    data As String,
    nodeSet As OpcNodeSet) As Boolean

Parameters

Name	Type	Description
data	String	The string to validate.
nodeSet	out OpcNodeSet	The OpcNodeSet version of the string.

Returns

Boolean

The value true if the specified data is a valid OpcNodeSet; otherwise the value false.

TryParse(OpcContext, string, out OpcNodeSet)

static · since v2.50

Determines whether a string within the context is a valid OpcNodeSet.

public static bool TryParse(
    OpcContext context,
    string data,
    out OpcNodeSet nodeSet)

Public Shared Function TryParse(
    context As OpcContext,
    data As String,
    nodeSet As OpcNodeSet) As Boolean

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to load the OpcNodeSet.
data	String	The string to validate.
nodeSet	out OpcNodeSet	The OpcNodeSet version of the string.

Returns

Boolean

The value true if the specified data is a valid OpcNodeSet; otherwise the value false.

Exceptions

Exception	Condition
ArgumentException	The context is a null reference (Nothing in Visual Basic).