Skip to content

Reference

OpcNodeId Members

Defines an identifier for a node in the address space of an OPC UA Server.

Reference

OpcNodeId Members ​

Type
OpcNodeId
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Constructors ​

OpcNodeId ​

22 overloads

OverloadDescription
OpcNodeId(byte[])Initializes a new instance of the OpcNodeId class using the value specified.
OpcNodeId(byte[], int)Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
OpcNodeId(byte[], OpcNamespace)Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.
OpcNodeId(Guid)Initializes a new instance of the OpcNodeId class using the value specified.
OpcNodeId(Guid, int)Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
OpcNodeId(Guid, OpcNamespace)Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.
OpcNodeId(int)Initializes a new instance of the OpcNodeId class using the value specified.
OpcNodeId(int, int)Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
OpcNodeId(int, OpcNamespace)Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.
OpcNodeId(uint)Initializes a new instance of the OpcNodeId class using the value specified.
OpcNodeId(uint, int)Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
OpcNodeId(uint, OpcNamespace)Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.
OpcNodeId(string)Initializes a new instance of the OpcNodeId class using the value specified.
OpcNodeId(string, OpcNamePath)Initializes a new instance of the OpcNodeId class using the value and path specified.
OpcNodeId(string, params OpcName[])Initializes a new instance of the OpcNodeId class using the value and pathElements specified.
OpcNodeId(string, int)Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
OpcNodeId(string, int, OpcNamePath)Initializes a new instance of the OpcNodeId class using the value, namespaceIndex and path specified.
OpcNodeId(string, int, params OpcName[])Initializes a new instance of the OpcNodeId class using the value, namespaceIndex and pathElements specified.
OpcNodeId(string, OpcNamespace)Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.
OpcNodeId(string, OpcNamespace, OpcNamePath)Initializes a new instance of the OpcNodeId class using the value, nodeNamespace and path specified.
OpcNodeId(string, OpcNamespace, params OpcName[])Initializes a new instance of the OpcNodeId class using the value, nodeNamespace and pathElements specified.
OpcNodeId(OpcNodeId)Initializes a new instance of the OpcNodeId class using the other specified.

OpcNodeId(byte[]) ​

Initializes a new instance of the OpcNodeId class using the value specified.

csharp
public OpcNodeId(byte[] value)
vbnet
Public Sub New(value As Byte())

Parameters

NameTypeDescription
valueByte[]The opaque value of the identifier to represent. A value equals a null reference (Nothing in Visual Basic) or an array with the length equals to zero results into a null identifier (see IsNull).

OpcNodeId(byte[], int) ​

Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.

csharp
public OpcNodeId(byte[] value, int namespaceIndex)
vbnet
Public Sub New(value As Byte(), namespaceIndex As Integer)

Parameters

NameTypeDescription
valueByte[]The opaque value of the identifier to represent. A value equals a null reference (Nothing in Visual Basic) or an array with the length equals to zero results into a null identifier (see IsNull).
namespaceIndexInt32The index of the namespace that this identifier should refer to.

OpcNodeId(byte[], OpcNamespace) ​

Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.

csharp
public OpcNodeId(byte[] value, OpcNamespace nodeNamespace)
vbnet
Public Sub New(value As Byte(), nodeNamespace As OpcNamespace)

Parameters

NameTypeDescription
valueByte[]The opaque value of the identifier to represent. A value equals a null reference (Nothing in Visual Basic) or an array with the length equals to zero results into a null identifier (see IsNull).
nodeNamespaceOpcNamespaceThe namespace that this identifier should refer to.

OpcNodeId(Guid) ​

Initializes a new instance of the OpcNodeId class using the value specified.

csharp
public OpcNodeId(Guid value)
vbnet
Public Sub New(value As Guid)

Parameters

NameTypeDescription
valueGuidThe general unique identifier (= GUID) to use as the value of the identifier to represent. A value equals Empty results into a null identifier (see IsNull).

OpcNodeId(Guid, int) ​

Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.

csharp
public OpcNodeId(Guid value, int namespaceIndex)
vbnet
Public Sub New(value As Guid, namespaceIndex As Integer)

Parameters

NameTypeDescription
valueGuidThe general unique identifier (= GUID) to use as the value of the identifier to represent. A value equals Empty results into a null identifier (see IsNull).
namespaceIndexInt32The index of the namespace that this identifier should refer to.

OpcNodeId(Guid, OpcNamespace) ​

Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.

csharp
public OpcNodeId(Guid value, OpcNamespace nodeNamespace)
vbnet
Public Sub New(value As Guid, nodeNamespace As OpcNamespace)

Parameters

NameTypeDescription
valueGuidThe general unique identifier (= GUID) to use as the value of the identifier to represent. A value equals Empty results into a null identifier (see IsNull).
nodeNamespaceOpcNamespaceThe namespace that this identifier should refer to.

OpcNodeId(int) ​

Initializes a new instance of the OpcNodeId class using the value specified.

csharp
public OpcNodeId(int value)
vbnet
Public Sub New(value As Integer)

Parameters

NameTypeDescription
valueInt32The numeric value of the identifier to represent. A value equals zero results into a null identifier (see IsNull).

OpcNodeId(int, int) ​

Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.

csharp
public OpcNodeId(int value, int namespaceIndex)
vbnet
Public Sub New(value As Integer, namespaceIndex As Integer)

Parameters

NameTypeDescription
valueInt32The numeric value of the identifier to represent. A value equals zero results into a null identifier (see IsNull).
namespaceIndexInt32The index of the namespace that this identifier should refer to.

OpcNodeId(int, OpcNamespace) ​

Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.

csharp
public OpcNodeId(int value, OpcNamespace nodeNamespace)
vbnet
Public Sub New(value As Integer, nodeNamespace As OpcNamespace)

Parameters

NameTypeDescription
valueInt32The numeric value of the identifier to represent. A value equals zero results into a null identifier (see IsNull).
nodeNamespaceOpcNamespaceThe namespace that this identifier should refer to.

OpcNodeId(uint) ​

Initializes a new instance of the OpcNodeId class using the value specified.

csharp
[CLSCompliant(false)]
public OpcNodeId(uint value)
vbnet
<CLSCompliant(False)>
Public Sub New(value As UInteger)

Parameters

NameTypeDescription
valueUInt32The numeric value of the identifier to represent. A value equals zero results into a null identifier (see IsNull).

OpcNodeId(uint, int) ​

Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.

csharp
[CLSCompliant(false)]
public OpcNodeId(uint value, int namespaceIndex)
vbnet
<CLSCompliant(False)>
Public Sub New(value As UInteger, namespaceIndex As Integer)

Parameters

NameTypeDescription
valueUInt32The numeric value of the identifier to represent. A value equals zero results into a null identifier (see IsNull).
namespaceIndexInt32The index of the namespace that this identifier should refer to.

OpcNodeId(uint, OpcNamespace) ​

Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.

csharp
[CLSCompliant(false)]
public OpcNodeId(uint value, OpcNamespace nodeNamespace)
vbnet
<CLSCompliant(False)>
Public Sub New(value As UInteger, nodeNamespace As OpcNamespace)

Parameters

NameTypeDescription
valueUInt32The numeric value of the identifier to represent. A value equals zero results into a null identifier (see IsNull).
nodeNamespaceOpcNamespaceThe namespace that this identifier should refer to.

OpcNodeId(string) ​

Initializes a new instance of the OpcNodeId class using the value specified.

csharp
public OpcNodeId(string value)
vbnet
Public Sub New(value As String)

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).

OpcNodeId(string, OpcNamePath) ​

Initializes a new instance of the OpcNodeId class using the value and path specified.

csharp
public OpcNodeId(string value, OpcNamePath path)
vbnet
Public Sub New(value As String, path As OpcNamePath)

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).
pathOpcNamePathThe logical (= physically not available in the address space) portion of the identifier.

OpcNodeId(string, params OpcName[]) ​

Initializes a new instance of the OpcNodeId class using the value and pathElements specified.

csharp
public OpcNodeId(string value, params OpcName[] pathElements)
vbnet
Public Sub New(value As String, ParamArray pathElements As OpcName())

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).
pathElementsparams OpcName[]The elements of the OpcNamePath to use as the logical (= physically not available in the address space) portion of the identifier.

OpcNodeId(string, int) ​

Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.

csharp
public OpcNodeId(string value, int namespaceIndex)
vbnet
Public Sub New(value As String, namespaceIndex As Integer)

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).
namespaceIndexInt32The index of the namespace that this identifier should refer to.

OpcNodeId(string, int, OpcNamePath) ​

Initializes a new instance of the OpcNodeId class using the value, namespaceIndex and path specified.

csharp
public OpcNodeId(string value, int namespaceIndex, OpcNamePath path)
vbnet
Public Sub New(value As String, namespaceIndex As Integer, path As OpcNamePath)

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).
namespaceIndexInt32The index of the namespace that this identifier should refer to.
pathOpcNamePathThe logical (= physically not available in the address space) portion of the identifier.

OpcNodeId(string, int, params OpcName[]) ​

Initializes a new instance of the OpcNodeId class using the value, namespaceIndex and pathElements specified.

csharp
public OpcNodeId(
    string value,
    int namespaceIndex,
    params OpcName[] pathElements)
vbnet
Public Sub New(
    value As String,
    namespaceIndex As Integer,
    ParamArray pathElements As OpcName())

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).
namespaceIndexInt32The index of the namespace that this identifier should refer to.
pathElementsparams OpcName[]The elements of the OpcNamePath to use as the logical (= physically not available in the address space) portion of the identifier.

OpcNodeId(string, OpcNamespace) ​

Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.

csharp
public OpcNodeId(string value, OpcNamespace nodeNamespace)
vbnet
Public Sub New(value As String, nodeNamespace As OpcNamespace)

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).
nodeNamespaceOpcNamespaceThe namespace that this identifier should refer to.

OpcNodeId(string, OpcNamespace, OpcNamePath) ​

Initializes a new instance of the OpcNodeId class using the value, nodeNamespace and path specified.

csharp
public OpcNodeId(string value, OpcNamespace nodeNamespace, OpcNamePath path)
vbnet
Public Sub New(
    value As String,
    nodeNamespace As OpcNamespace,
    path As OpcNamePath)

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).
nodeNamespaceOpcNamespaceThe namespace that this identifier should refer to.
pathOpcNamePathThe logical (= physically not available in the address space) portion of the identifier.

OpcNodeId(string, OpcNamespace, params OpcName[]) ​

Initializes a new instance of the OpcNodeId class using the value, nodeNamespace and pathElements specified.

csharp
public OpcNodeId(
    string value,
    OpcNamespace nodeNamespace,
    params OpcName[] pathElements)
vbnet
Public Sub New(
    value As String,
    nodeNamespace As OpcNamespace,
    ParamArray pathElements As OpcName())

Parameters

NameTypeDescription
valueStringThe string value of the identifier to represent. A null reference (Nothing in Visual Basic) or a value equals Empty results into a null identifier (see IsNull).
nodeNamespaceOpcNamespaceThe namespace that this identifier should refer to.
pathElementsparams OpcName[]The elements of the OpcNamePath to use as the logical (= physically not available in the address space) portion of the identifier.

OpcNodeId(OpcNodeId) ​

Initializes a new instance of the OpcNodeId class using the other specified.

csharp
public OpcNodeId(OpcNodeId other)
vbnet
Public Sub New(other As OpcNodeId)

Parameters

NameTypeDescription
otherOpcNodeIdThe OpcNodeId from that a deep copy is to be created.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe other is a null reference (Nothing in Visual Basic).

Fields ​

DefaultSeparator ​

static

Defines the character which is used to separate parent-child related node identifiers from each other when constructing a parent-child related node identifier using Of.

csharp
public static readonly char DefaultSeparator
vbnet
Public Shared ReadOnly DefaultSeparator As Char

Field value

Char

DefaultSeparatorOfPath ​

static

Defines the character which is used to separate node-component-node related node identifiers form each other when constructing a node-component-node related node identifier using WithPath.

csharp
public static readonly char DefaultSeparatorOfPath
vbnet
Public Shared ReadOnly DefaultSeparatorOfPath As Char

Field value

Char

Properties ​

Factory ​

static

Gets or sets the globally used OpcNodeIdFactory to generate new instances of the OpcNodeId class.

csharp
public static OpcNodeIdFactory Factory { get; set; }
vbnet
Public Shared Property Factory As OpcNodeIdFactory

Property value

OpcNodeIdFactory

An instance of a sub class of the OpcNodeIdFactory class. The default factory used is the OpcNominalNodeIdFactory.

IsAbsolute ​

Gets a value indicating whether the identifier is an absolute one.

csharp
public bool IsAbsolute { get; }
vbnet
Public ReadOnly Property IsAbsolute As Boolean

Property value

Boolean

The value true if the Namespace is an absolute namespace and is therefore not server dependent upon its Index; otherwise the value false.

IsNull ​

Gets a value indicating whether the node identifier is a null identifier.

csharp
public bool IsNull { get; }
vbnet
Public ReadOnly Property IsNull As Boolean

Property value

Boolean

The value true if the Value defines a Type specific definition of a null identifier; otherwise the value false.

Remarks

A null identifier originates when a node identifier is created using:

  • A byte-array as the identifier value. In case there the Opaque identifier value is a null reference (Nothing in Visual Basic) or an empty array (the length is equals zero).
  • A Guid as the identifier value. In case there the Guid identifier value is equals to Empty.
  • A int or uint as the identifier value. In case there the Numeric identifier value is equals to zero.
  • A string as the identifier value. In case there the String identifier value is a null reference (Nothing in Visual Basic) or equals to Empty.

Namespace ​

Gets the OpcNamespace used by the OpcNodeId to describe the namespace to that the node identifier belongs.

csharp
public OpcNamespace Namespace { get; }
vbnet
Public ReadOnly Property [Namespace] As OpcNamespace

Property value

OpcNamespace

An instance of the OpcNamespace with the known information about the namespace to that the OpcNodeId belongs.

NamespaceIndex ​

Gets the index of the namespace that this identifier belongs.

csharp
public int NamespaceIndex { get; }
vbnet
Public ReadOnly Property NamespaceIndex As Integer

Property value

Int32

The index value which refers to the namespace in the namespace array of the server to that the node identifier belong.

Remarks

The available namespaces of the server can be retrieved through reading the value of the namespaces-node using the node identifier 'OpcObjectTypes.Server.Namespaces'.

NamespaceUri ​

Gets the uniform resource identifier (URI) of the namespace referred by the NamespaceIndex.

csharp
public Uri NamespaceUri { get; }
vbnet
Public ReadOnly Property NamespaceUri As Uri

Property value

Uri

The Uri to that the OpcNodeId refers using the NamespaceIndex.

Null ​

static

Gets the default null node identifier.

csharp
public static OpcNodeId Null { get; }
vbnet
Public Shared ReadOnly Property Null As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId which can be used for general purpose in cases there a null node identifier is enough.

OriginalFormat ​

Gets the original format of the node identifier from that the instance was constructed.

csharp
public OpcNodeIdFormat OriginalFormat { get; }
vbnet
Public ReadOnly Property OriginalFormat As OpcNodeIdFormat

Property value

OpcNodeIdFormat

The format used by the string passed to the Parse method from that the identifier has been constructed. If this instance has not been constructed through a Parse call a constructor dependent OpcNodeIdFormat enumeration member.

OriginalString ​

Gets the original node identifier string that was passed to the Parse method.

csharp
public string OriginalString { get; }
vbnet
Public ReadOnly Property OriginalString As String

Property value

String

A string containing the exact node identifier specified from this instance was constructed; otherwise Empty.

Path ​

Gets the path portion of the Value which refers to the logical (= physically not available in the address space) portion of the identifier.

csharp
public OpcNamePath Path { get; }
vbnet
Public ReadOnly Property Path As OpcNamePath

Property value

OpcNamePath

An instance of the OpcNamePath identifying the browse path to use to determine the according entity through the physically existing members in the address space.

Remarks

A OpcNodeId with a OpcNamePath not equals Empty identifies an entity which is not necessarily physically available in the address space. We define that the identifier of the physical ancestor of the entity identified by such an identifier (its logical owner which is physically available in the address space) is encoded in the Value of its OpcNodeId followed by the string formatted Path. Excluding the Path from this OpcNodeId (see ExcludePath) results into the identifier of the 'physical' ancestor. Using these (path-less) identifier the ancestor can be looked up in the address space and can be used to browse for the entity using the Path of the identifier of its successor.

Resolution ​

static · since v2.26

Gets an instance of the OpcNodeIdResolution class used to resolve node identifiers.

csharp
public static OpcNodeIdResolution Resolution { get; }
vbnet
Public Shared ReadOnly Property Resolution As OpcNodeIdResolution

Property value

OpcNodeIdResolution

An instance of the OpcNodeIdResolution class.

Type ​

Gets the type of Value used to define the identifier.

csharp
public OpcNodeIdType Type { get; }
vbnet
Public ReadOnly Property Type As OpcNodeIdType

Property value

OpcNodeIdType

One of the members defined by the OpcNodeIdType enumeration. The value dependents on the type of Value used for the identifier.

Value ​

Gets the Type dependent value of the identifier represented.

csharp
public object Value { get; }
vbnet
Public ReadOnly Property Value As Object

Property value

Object

A byte-array, Guid, uint or string value used to define the identifier.

ValueAsString ​

Gets the Value formatted as a string.

csharp
public string ValueAsString { get; }
vbnet
Public ReadOnly Property ValueAsString As String

Property value

String

A string representing the textual representation of the Value.

Methods ​

Compare ​

static · since v2.41

Compares two specified OpcNodeId objects according to a specific comparison method.

csharp
public static int Compare(
    OpcNodeId first,
    OpcNodeId second,
    OpcNodeIdComparison comparisonType = OpcNodeIdComparison.Default)
vbnet
Public Shared Function Compare(
    first As OpcNodeId,
    second As OpcNodeId,
    comparisonType As OpcNodeIdComparison = OpcNodeIdComparison.Default) As Integer

Parameters

NameTypeDescription
firstOpcNodeIdThe first OpcNodeId to compare, or a null reference (Nothing in Visual Basic).
secondOpcNodeIdThe second OpcNodeId to compare, or a null reference (Nothing in Visual Basic).
comparisonTypeOpcNodeIdComparisonOne of the members defined by the OpcNodeIdComparison enumeration that specifies the rules for the comparison. Optional, default OpcNodeIdComparison.Default.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(T)).

CompareTo ​

3 overloads

OverloadDescription
CompareTo(object)Compares the current OpcNodeId with the other.
CompareTo(OpcNodeId)Compares the current OpcNodeId with another OpcNodeId.
CompareTo(OpcNodeId, OpcNodeIdComparison)since v2.41Compares the current OpcNodeId with another OpcNodeId according to a specific comparison method.

CompareTo(object) ​

Compares the current OpcNodeId with the other.

csharp
public int CompareTo(object other)
vbnet
Public Function CompareTo(other As Object) As Integer

Parameters

NameTypeDescription
otherObjectThe OpcNodeId to compare with this OpcNodeId.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(object)).

Implements

CompareTo(object)

CompareTo(OpcNodeId) ​

Compares the current OpcNodeId with another OpcNodeId.

csharp
public int CompareTo(OpcNodeId other)
vbnet
Public Function CompareTo(other As OpcNodeId) As Integer

Parameters

NameTypeDescription
otherOpcNodeIdThe OpcNodeId to compare with this OpcNodeId.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(T)).

Implements

CompareTo(OpcNodeId)

CompareTo(OpcNodeId, OpcNodeIdComparison) ​

since v2.41

Compares the current OpcNodeId with another OpcNodeId according to a specific comparison method.

csharp
public int CompareTo(OpcNodeId other, OpcNodeIdComparison comparisonType)
vbnet
Public Function CompareTo(
    other As OpcNodeId,
    comparisonType As OpcNodeIdComparison) As Integer

Parameters

NameTypeDescription
otherOpcNodeIdThe OpcNodeId to compare with this OpcNodeId.
comparisonTypeOpcNodeIdComparisonOne of the members defined by the OpcNodeIdComparison enumeration that specifies the rules for the comparison.

Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(T)).

Equals ​

5 overloads

OverloadDescription
Equals(OpcNodeId, OpcNodeId)static · since v2.18Determines whether two specified OpcNodeId objects are equals.
Equals(OpcNodeId, OpcNodeId, OpcNodeIdComparison)static · since v2.18Determines whether two specified OpcNodeId objects are equals according to a specific comparison method.
Equals(object)overrideDetermines whether the specified other is equal to this OpcNodeId.
Equals(OpcNodeId)Determines whether the specified other is equal to this OpcNodeId.
Equals(OpcNodeId, OpcNodeIdComparison)since v2.18Determines whether the specified OpcNodeId object is equals to this instance according to a specific comparison method.

Equals(OpcNodeId, OpcNodeId) ​

static · since v2.18

Determines whether two specified OpcNodeId objects are equals.

csharp
public static bool Equals(OpcNodeId first, OpcNodeId second)
vbnet
Public Shared Function Equals(
    first As OpcNodeId,
    second As OpcNodeId) As Boolean

Parameters

NameTypeDescription
firstOpcNodeIdThe first OpcNodeId to compare, or a null reference (Nothing in Visual Basic).
secondOpcNodeIdThe second OpcNodeId to compare, or a null reference (Nothing in Visual Basic).

Returns

Boolean

The value true if the first is equals to the second; otherwise the value false.

Equals(OpcNodeId, OpcNodeId, OpcNodeIdComparison) ​

static · since v2.18

Determines whether two specified OpcNodeId objects are equals according to a specific comparison method.

csharp
public static bool Equals(
    OpcNodeId first,
    OpcNodeId second,
    OpcNodeIdComparison comparisonType)
vbnet
Public Shared Function Equals(
    first As OpcNodeId,
    second As OpcNodeId,
    comparisonType As OpcNodeIdComparison) As Boolean

Parameters

NameTypeDescription
firstOpcNodeIdThe first OpcNodeId to compare, or a null reference (Nothing in Visual Basic).
secondOpcNodeIdThe second OpcNodeId to compare, or a null reference (Nothing in Visual Basic).
comparisonTypeOpcNodeIdComparisonOne of the members defined by the OpcNodeIdComparison enumeration that specifies the rules for the comparison.

Returns

Boolean

The value true if the first is equals to the second; otherwise the value false.

Equals(object) ​

override

Determines whether the specified other is equal to this OpcNodeId.

csharp
public override bool Equals(object other)
vbnet
Public Overrides Function Equals(other As Object) As Boolean

Parameters

NameTypeDescription
otherObjectThe OpcNodeId to compare to the current OpcNodeId.

Returns

Boolean

The value true if the specified OpcNodeId is equal to the current OpcNodeId; otherwise the value false.

Overrides

Equals(object)

Equals(OpcNodeId) ​

Determines whether the specified other is equal to this OpcNodeId.

csharp
public bool Equals(OpcNodeId other)
vbnet
Public Function Equals(other As OpcNodeId) As Boolean

Parameters

NameTypeDescription
otherOpcNodeIdThe OpcNodeId to compare to the current OpcNodeId.

Returns

Boolean

The value true if the specified OpcNodeId is equal to the current OpcNodeId; otherwise the value false.

Implements

Equals(OpcNodeId)

Equals(OpcNodeId, OpcNodeIdComparison) ​

since v2.18

Determines whether the specified OpcNodeId object is equals to this instance according to a specific comparison method.

csharp
public bool Equals(OpcNodeId other, OpcNodeIdComparison comparisonType)
vbnet
Public Function Equals(
    other As OpcNodeId,
    comparisonType As OpcNodeIdComparison) As Boolean

Parameters

NameTypeDescription
otherOpcNodeIdThe OpcNodeId to compare to this instance.
comparisonTypeOpcNodeIdComparisonOne of the members defined by the OpcNodeIdComparison enumeration that specifies the rules for the comparison.

Returns

Boolean

The value true if the other is equals to this instance; otherwise the value false.

ExcludePath ​

Retrieves a new OpcNodeId there its Value not longer contains any Path information.

csharp
public OpcNodeId ExcludePath()
vbnet
Public Function ExcludePath() As OpcNodeId

Returns

OpcNodeId

A new instance of the OpcNodeId class using the same Namespace as this OpcNodeId and the same Value, but without any Path portion used by this OpcNodeId.

Remarks

In case there the identifier of the ancestor from that this OpcNodeId (with path) was created from is not of the String type (see Type) this method will not recover its original OpcNodeIdType.

GetHashCode ​

override

Retrieves a hash code for this OpcNodeId.

csharp
public override int GetHashCode()
vbnet
Public Overrides Function GetHashCode() As Integer

Returns

Int32

An int that contains the hash code for the OpcNodeId.

Overrides

GetHashCode()

IsNullOrEmpty ​

static · since v2.14

Indicates whether the specified OpcNodeId is null or its Value is null, default or an empty string ("").

csharp
public static bool IsNullOrEmpty(OpcNodeId identifier)
vbnet
Public Shared Function IsNullOrEmpty(identifier As OpcNodeId) As Boolean

Parameters

NameTypeDescription
identifierOpcNodeIdThe OpcNodeId to test.

Returns

Boolean

The value true if the identifier parameter or its Value is null, default or an empty string (""); otherwise the value false.

Remarks

This method ignores the circumstance whether the Namespace of the identifier might be specified anyway.

Of ​

static · 3 overloads

OverloadDescription
Of(OpcName)staticCreates a new OpcNodeId instance from the name specified.
Of(OpcName, OpcNodeId)staticCreates a new parent-child related OpcNodeId instance from the name and parentNodeId specified.
Of(OpcName, OpcNodeId, char)staticCreates a new parent-child related OpcNodeId instance from the name and parentNodeId specified.

Exceptions (all overloads)

ExceptionCondition
ArgumentExceptionThe name does not provide a Value nor a NamespaceIndex from that a OpcNodeId can be created (see IsNull).

Of(OpcName) ​

static

Creates a new OpcNodeId instance from the name specified.

csharp
public static OpcNodeId Of(OpcName name)
vbnet
Public Shared Function [Of](name As OpcName) As OpcNodeId

Parameters

NameTypeDescription
nameOpcNameThe OpcName its Value and NamespaceIndex is used to create a new OpcNodeId of the type String.

Returns

OpcNodeId

A new instance of the OpcNodeId created from the Value and NamespaceIndex of the name specified.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe name is a null reference (Nothing in Visual Basic).

Of(OpcName, OpcNodeId) ​

static

Creates a new parent-child related OpcNodeId instance from the name and parentNodeId specified.

csharp
public static OpcNodeId Of(OpcName name, OpcNodeId parentNodeId)
vbnet
Public Shared Function [Of](
    name As OpcName,
    parentNodeId As OpcNodeId) As OpcNodeId

Parameters

NameTypeDescription
nameOpcNameThe OpcName its Value and NamespaceIndex is used to create a new OpcNodeId of the type String.
parentNodeIdOpcNodeIdThe OpcNodeId of the parent node its identifier is to be integrated into the new node identifier.

Returns

OpcNodeId

A new instance of the OpcNodeId created from the Value and NamespaceIndex of the name specified.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe name or parentNodeId is a null reference (Nothing in Visual Basic).

Of(OpcName, OpcNodeId, char) ​

static

Creates a new parent-child related OpcNodeId instance from the name and parentNodeId specified.

csharp
public static OpcNodeId Of(OpcName name, OpcNodeId parentNodeId, char separator)
vbnet
Public Shared Function [Of](
    name As OpcName,
    parentNodeId As OpcNodeId,
    separator As Char) As OpcNodeId

Parameters

NameTypeDescription
nameOpcNameThe OpcName its Value and NamespaceIndex is used to create a new OpcNodeId of the type String.
parentNodeIdOpcNodeIdThe OpcNodeId of the parent node its identifier is to be integrated into the new node identifier.
separatorCharThe char used to separate the child node identifier from the parentNodeId.

Returns

OpcNodeId

A new instance of the OpcNodeId created from the Value and NamespaceIndex of the name specified.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe name or parentNodeId is a null reference (Nothing in Visual Basic).

Remarks

In case there the parentNodeId ends with the separator specified it will be not adopted by the newly created node identifier.

Parse ​

static

Converts a node identifier string to a OpcNodeId instance.

csharp
public static OpcNodeId Parse(string value)
vbnet
Public Shared Function Parse(value As String) As OpcNodeId

Parameters

NameTypeDescription
valueStringA string that contains a node identifier.

Returns

OpcNodeId

An instance of the OpcNodeId class.

Exceptions

ExceptionCondition
FormatExceptionThe value is not a valid node identifier.

Resolve ​

Resolves this node identifier to a new node identifier its Namespace might be known in the context of the resolver object specified.

csharp
public OpcNodeId Resolve(IOpcNamespaceResolver resolver)
vbnet
Public Function Resolve(resolver As IOpcNamespaceResolver) As OpcNodeId

Parameters

NameTypeDescription
resolverIOpcNamespaceResolverAn instance implementing the IOpcNamespaceResolver interface to use to retrieve the namespace known using the namespace information of this identifier.

Returns

OpcNodeId

A deep copy of this OpcNodeId using either the resolved namespace or the same namespace as this node identifier.

Exceptions

ExceptionCondition
ArgumentNullExceptionThe resolver is a null reference (Nothing in Visual Basic).

ToString ​

2 overloads

OverloadDescription
ToString()overrideReturns a string representing the node identifier.
ToString(OpcNodeIdFormat)Returns a string representing the node identifier in the format specified.

ToString() ​

override

Returns a string representing the node identifier.

csharp
public override string ToString()
vbnet
Public Overrides Function ToString() As String

Returns

String

A string formatted using the OriginalFormat from that the OpcNodeId has been constructed. The format dependents on the format detected through calling Parse or the format defined using a specific constructor.

Overrides

ToString()

ToString(OpcNodeIdFormat) ​

Returns a string representing the node identifier in the format specified.

csharp
public string ToString(OpcNodeIdFormat format)
vbnet
Public Function ToString(format As OpcNodeIdFormat) As String

Parameters

NameTypeDescription
formatOpcNodeIdFormatOne of the formatting styles defined by the OpcNodeIdFormat enumeration.

Returns

String

A string formatted using the format specified.

TryParse ​

static

Determines whether a string is a valid node identifier.

csharp
public static bool TryParse(string value, out OpcNodeId nodeId)
vbnet
Public Shared Function TryParse(value As String, nodeId As OpcNodeId) As Boolean

Parameters

NameTypeDescription
valueStringThe string to validate.
nodeIdout OpcNodeIdThe OpcNodeId version of the string.

Returns

Boolean

The value true, if value is a valid node identifier; otherwise the value false.

UriIdentifier ​

static

Retrieves the Value of the nodeId as an Uri.

csharp
public static Uri UriIdentifier(OpcNodeId nodeId)
vbnet
Public Shared Function UriIdentifier(nodeId As OpcNodeId) As Uri

Parameters

NameTypeDescription
nodeIdOpcNodeIdThe OpcNodeId from its Value an Uri is to be retrieved.

Returns

Uri

An Uri if the Type of the nodeId is equals String and the Value can be parsed to an Uri; otherwise a null reference (Nothing in Visual Basic).

Exceptions

ExceptionCondition
ArgumentNullExceptionThe nodeId is a null reference (Nothing in Visual Basic).

Remarks

This method can be used in scenarios there a server uses Uri-formatted strings as the identifier for its nodes, while its node managers defines different namespaces where the namespaceUris define base-uri's of the node identifier uri's. This allows the framework to determine the manager of a node without the need to know the concrete index of the namespace which defines the identifier of a node.

WithPath ​

2 overloads

OverloadDescription
WithPath(OpcNamePath)Defines a new OpcNodeId using the Value, Namespace and Path of this OpcNodeId by combining this Path with the path specified.
WithPath(params OpcName[])Defines a new OpcNodeId using the Value, Namespace and Path of this OpcNodeId by combining this Path with the pathElements specified.

WithPath(OpcNamePath) ​

Defines a new OpcNodeId using the Value, Namespace and Path of this OpcNodeId by combining this Path with the path specified.

csharp
public OpcNodeId WithPath(OpcNamePath path)
vbnet
Public Function WithPath(path As OpcNamePath) As OpcNodeId

Parameters

NameTypeDescription
pathOpcNamePathThe logical (= physically not available in the address space) portion to append to the Path of this OpcNodeId for the identifier to create.

Returns

OpcNodeId

A new OpcNodeId derived from this OpcNodeId by extending the Path using the path specified.

Remarks

In case there this OpcNodeId is not of the String type (see Type) the new one will be, because of the Path is encoded in the Value.

WithPath(params OpcName[]) ​

Defines a new OpcNodeId using the Value, Namespace and Path of this OpcNodeId by combining this Path with the pathElements specified.

csharp
public OpcNodeId WithPath(params OpcName[] pathElements)
vbnet
Public Function WithPath(ParamArray pathElements As OpcName()) As OpcNodeId

Parameters

NameTypeDescription
pathElementsparams OpcName[]The elements of the OpcNamePath to use as the logical (= physically not available in the address space) portion to append to the Path of this OpcNodeId for the identifier to create.

Returns

OpcNodeId

A new OpcNodeId derived from this OpcNodeId by extending the Path using the pathElements specified.

Remarks

In case there this OpcNodeId is not of the String type (see Type) the new one will be, because of the Path is encoded in the Value.

Operators ​

Equality ​

static

Returns a value indicating whether two instance of OpcNodeId are equal.

csharp
public static bool operator ==(OpcNodeId left, OpcNodeId right)
vbnet
Public Shared Operator =(left As OpcNodeId, right As OpcNodeId) As Boolean

Parameters

NameTypeDescription
leftOpcNodeIdThe first OpcNodeId to compare.
rightOpcNodeIdThe second OpcNodeId to compare.

Returns

Boolean

The value true if left and right are equal; otherwise the value false.

Explicit ​

static · 2 overloads

OverloadDescription
explicit operator NodeId(OpcNodeId)staticConverts a OpcNodeId to an NodeId object.
explicit operator ExpandedNodeId(OpcNodeId)static · since v2.16Converts a OpcNodeId to an ExpandedNodeId object.

explicit operator NodeId(OpcNodeId) ​

static

Converts a OpcNodeId to an NodeId object.

csharp
[CLSCompliant(false)]
public static explicit operator NodeId(OpcNodeId value)
vbnet
<CLSCompliant(False)>
Public Shared Narrowing Operator CType(value As OpcNodeId) As NodeId

Parameters

NameTypeDescription
valueOpcNodeIdA OpcNodeId that represents the node id.

Returns

NodeId

An instance of the NodeId class initialized from the value.

explicit operator ExpandedNodeId(OpcNodeId) ​

static · since v2.16

Converts a OpcNodeId to an ExpandedNodeId object.

csharp
[CLSCompliant(false)]
public static explicit operator ExpandedNodeId(OpcNodeId value)
vbnet
<CLSCompliant(False)>
Public Shared Narrowing Operator CType(value As OpcNodeId) As ExpandedNodeId

Parameters

NameTypeDescription
valueOpcNodeIdA OpcNodeId that represents the node id.

Returns

ExpandedNodeId

An instance of the ExpandedNodeId class initialized from the value.

GreaterThan ​

static

Determines whether the first specified OpcNodeId object is greater than the second specified OpcNodeId object.

csharp
public static bool operator >(OpcNodeId left, OpcNodeId right)
vbnet
Public Shared Operator >(left As OpcNodeId, right As OpcNodeId) As Boolean

Parameters

NameTypeDescription
leftOpcNodeIdThe first OpcNodeId object.
rightOpcNodeIdThe second OpcNodeId object.

Returns

Boolean

The value true if left is greater than right; otherwise, false.

GreaterThanOrEqual ​

static

Determines whether the first specified OpcNodeId object is greater than or equal to the second specified OpcNodeId object.

csharp
public static bool operator >=(OpcNodeId left, OpcNodeId right)
vbnet
Public Shared Operator >=(left As OpcNodeId, right As OpcNodeId) As Boolean

Parameters

NameTypeDescription
leftOpcNodeIdThe first OpcNodeId object.
rightOpcNodeIdThe second OpcNodeId object.

Returns

Boolean

The value true if left is greater than or equal to right; otherwise, false.

Implicit ​

static · 4 overloads

OverloadDescription
implicit operator OpcNodeId(string)staticConverts a string to an OpcNodeId object.
implicit operator OpcNodeId(int)staticConverts a int to an OpcNodeId object.
implicit operator OpcNodeId(NodeId)staticConverts a NodeId to an OpcNodeId object.
implicit operator OpcNodeId(ExpandedNodeId)staticConverts a ExpandedNodeId to an OpcNodeId object.

implicit operator OpcNodeId(string) ​

static

Converts a string to an OpcNodeId object.

csharp
public static implicit operator OpcNodeId(string value)
vbnet
Public Shared Widening Operator CType(value As String) As OpcNodeId

Parameters

NameTypeDescription
valueStringA string that represents the node id.

Returns

OpcNodeId

An instance of the OpcNodeId class initialized from the value.

implicit operator OpcNodeId(int) ​

static

Converts a int to an OpcNodeId object.

csharp
public static implicit operator OpcNodeId(int value)
vbnet
Public Shared Widening Operator CType(value As Integer) As OpcNodeId

Parameters

NameTypeDescription
valueInt32A int that represents the node id.

Returns

OpcNodeId

An instance of the OpcNodeId class initialized from the value.

implicit operator OpcNodeId(NodeId) ​

static

Converts a NodeId to an OpcNodeId object.

csharp
[CLSCompliant(false)]
public static implicit operator OpcNodeId(NodeId value)
vbnet
<CLSCompliant(False)>
Public Shared Widening Operator CType(value As NodeId) As OpcNodeId

Parameters

NameTypeDescription
valueNodeIdA NodeId that represents the node id.

Returns

OpcNodeId

An instance of the OpcNodeId class initialized from the value.

implicit operator OpcNodeId(ExpandedNodeId) ​

static

Converts a ExpandedNodeId to an OpcNodeId object.

csharp
[CLSCompliant(false)]
public static implicit operator OpcNodeId(ExpandedNodeId value)
vbnet
<CLSCompliant(False)>
Public Shared Widening Operator CType(value As ExpandedNodeId) As OpcNodeId

Parameters

NameTypeDescription
valueExpandedNodeIdA ExpandedNodeId that represents expanded the node id.

Returns

OpcNodeId

An instance of the OpcNodeId class initialized from the value.

Inequality ​

static

Returns a value indicating whether two instances of OpcNodeId are not equal.

csharp
public static bool operator !=(OpcNodeId left, OpcNodeId right)
vbnet
Public Shared Operator <>(left As OpcNodeId, right As OpcNodeId) As Boolean

Parameters

NameTypeDescription
leftOpcNodeIdThe first OpcNodeId to compare.
rightOpcNodeIdThe second OpcNodeId to compare.

Returns

Boolean

The value true if left and right are not equal; otherwise the value false.

LessThan ​

static

Determines whether the first specified OpcNodeId object is less than the second specified OpcNodeId object.

csharp
public static bool operator <(OpcNodeId left, OpcNodeId right)
vbnet
Public Shared Operator <(left As OpcNodeId, right As OpcNodeId) As Boolean

Parameters

NameTypeDescription
leftOpcNodeIdThe first OpcNodeId object.
rightOpcNodeIdThe second OpcNodeId object.

Returns

Boolean

The value true if left is less than right; otherwise the value false.

LessThanOrEqual ​

static

Determines whether the first specified OpcNodeId object is less than or equal to the second OpcNodeId object.

csharp
public static bool operator <=(OpcNodeId left, OpcNodeId right)
vbnet
Public Shared Operator <=(left As OpcNodeId, right As OpcNodeId) As Boolean

Parameters

NameTypeDescription
leftOpcNodeIdThe first OpcNodeId object.
rightOpcNodeIdThe second OpcNodeId object.

Returns

Boolean

The value true if left is less than or equal to right; otherwise the value false.