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
| Overload | Description |
|---|---|
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and path specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and pathElements specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value, namespaceIndex and path specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value, namespaceIndex and pathElements specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value, nodeNamespace and path specified. |
| OpcNodeId( | Initializes a new instance of the OpcNodeId class using the value, nodeNamespace and pathElements specified. |
| 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.
public OpcNodeId(byte[] value)Public Sub New(value As Byte())Parameters
| Name | Type | Description |
|---|---|---|
value | Byte[] | The opaque value of the identifier to represent. A value equals a null reference ( |
OpcNodeId(byte[], int)
Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
public OpcNodeId(byte[] value, int namespaceIndex)Public Sub New(value As Byte(), namespaceIndex As Integer)Parameters
| Name | Type | Description |
|---|---|---|
value | Byte[] | The opaque value of the identifier to represent. A value equals a null reference ( |
namespaceIndex | Int32 | The 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.
public OpcNodeId(byte[] value, OpcNamespace nodeNamespace)Public Sub New(value As Byte(), nodeNamespace As OpcNamespace)Parameters
| Name | Type | Description |
|---|---|---|
value | Byte[] | The opaque value of the identifier to represent. A value equals a null reference ( |
nodeNamespace | OpcNamespace | The namespace that this identifier should refer to. |
OpcNodeId(Guid)
Initializes a new instance of the OpcNodeId class using the value specified.
public OpcNodeId(Guid value)Public Sub New(value As Guid)Parameters
| Name | Type | Description |
|---|---|---|
value | Guid | The general unique identifier ( |
OpcNodeId(Guid, int)
Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
public OpcNodeId(Guid value, int namespaceIndex)Public Sub New(value As Guid, namespaceIndex As Integer)Parameters
| Name | Type | Description |
|---|---|---|
value | Guid | The general unique identifier ( |
namespaceIndex | Int32 | The 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.
public OpcNodeId(Guid value, OpcNamespace nodeNamespace)Public Sub New(value As Guid, nodeNamespace As OpcNamespace)Parameters
| Name | Type | Description |
|---|---|---|
value | Guid | The general unique identifier ( |
nodeNamespace | OpcNamespace | The namespace that this identifier should refer to. |
OpcNodeId(int)
Initializes a new instance of the OpcNodeId class using the value specified.
public OpcNodeId(int value)Public Sub New(value As Integer)Parameters
| Name | Type | Description |
|---|---|---|
value | Int32 | The numeric value of the identifier to represent. A value equals zero results into a null identifier ( |
OpcNodeId(int, int)
Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
public OpcNodeId(int value, int namespaceIndex)Public Sub New(value As Integer, namespaceIndex As Integer)Parameters
| Name | Type | Description |
|---|---|---|
value | Int32 | The numeric value of the identifier to represent. A value equals zero results into a null identifier ( |
namespaceIndex | Int32 | The 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.
public OpcNodeId(int value, OpcNamespace nodeNamespace)Public Sub New(value As Integer, nodeNamespace As OpcNamespace)Parameters
| Name | Type | Description |
|---|---|---|
value | Int32 | The numeric value of the identifier to represent. A value equals zero results into a null identifier ( |
nodeNamespace | OpcNamespace | The namespace that this identifier should refer to. |
OpcNodeId(uint)
Initializes a new instance of the OpcNodeId class using the value specified.
[CLSCompliant(false)]
public OpcNodeId(uint value)<CLSCompliant(False)>
Public Sub New(value As UInteger)Parameters
| Name | Type | Description |
|---|---|---|
value | UInt32 | The numeric value of the identifier to represent. A value equals zero results into a null identifier ( |
OpcNodeId(uint, int)
Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
[CLSCompliant(false)]
public OpcNodeId(uint value, int namespaceIndex)<CLSCompliant(False)>
Public Sub New(value As UInteger, namespaceIndex As Integer)Parameters
| Name | Type | Description |
|---|---|---|
value | UInt32 | The numeric value of the identifier to represent. A value equals zero results into a null identifier ( |
namespaceIndex | Int32 | The 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.
[CLSCompliant(false)]
public OpcNodeId(uint value, OpcNamespace nodeNamespace)<CLSCompliant(False)>
Public Sub New(value As UInteger, nodeNamespace As OpcNamespace)Parameters
| Name | Type | Description |
|---|---|---|
value | UInt32 | The numeric value of the identifier to represent. A value equals zero results into a null identifier ( |
nodeNamespace | OpcNamespace | The namespace that this identifier should refer to. |
OpcNodeId(string)
Initializes a new instance of the OpcNodeId class using the value specified.
public OpcNodeId(string value)Public Sub New(value As String)Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
OpcNodeId(string, OpcNamePath)
Initializes a new instance of the OpcNodeId class using the value and path specified.
public OpcNodeId(string value, OpcNamePath path)Public Sub New(value As String, path As OpcNamePath)Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
path | OpcNamePath | The logical ( |
OpcNodeId(string, params OpcName[])
Initializes a new instance of the OpcNodeId class using the value and pathElements specified.
public OpcNodeId(string value, params OpcName[] pathElements)Public Sub New(value As String, ParamArray pathElements As OpcName())Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
pathElements | params OpcName[] | The elements of the OpcNamePath to use as the logical ( |
OpcNodeId(string, int)
Initializes a new instance of the OpcNodeId class using the value and namespaceIndex specified.
public OpcNodeId(string value, int namespaceIndex)Public Sub New(value As String, namespaceIndex As Integer)Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
namespaceIndex | Int32 | The 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.
public OpcNodeId(string value, int namespaceIndex, OpcNamePath path)Public Sub New(value As String, namespaceIndex As Integer, path As OpcNamePath)Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
namespaceIndex | Int32 | The index of the namespace that this identifier should refer to. |
path | OpcNamePath | The logical ( |
OpcNodeId(string, int, params OpcName[])
Initializes a new instance of the OpcNodeId class using the value, namespaceIndex and pathElements specified.
public OpcNodeId(
string value,
int namespaceIndex,
params OpcName[] pathElements)Public Sub New(
value As String,
namespaceIndex As Integer,
ParamArray pathElements As OpcName())Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
namespaceIndex | Int32 | The index of the namespace that this identifier should refer to. |
pathElements | params OpcName[] | The elements of the OpcNamePath to use as the logical ( |
OpcNodeId(string, OpcNamespace)
Initializes a new instance of the OpcNodeId class using the value and nodeNamespace specified.
public OpcNodeId(string value, OpcNamespace nodeNamespace)Public Sub New(value As String, nodeNamespace As OpcNamespace)Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
nodeNamespace | OpcNamespace | The 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.
public OpcNodeId(string value, OpcNamespace nodeNamespace, OpcNamePath path)Public Sub New(
value As String,
nodeNamespace As OpcNamespace,
path As OpcNamePath)Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
nodeNamespace | OpcNamespace | The namespace that this identifier should refer to. |
path | OpcNamePath | The logical ( |
OpcNodeId(string, OpcNamespace, params OpcName[])
Initializes a new instance of the OpcNodeId class using the value, nodeNamespace and pathElements specified.
public OpcNodeId(
string value,
OpcNamespace nodeNamespace,
params OpcName[] pathElements)Public Sub New(
value As String,
nodeNamespace As OpcNamespace,
ParamArray pathElements As OpcName())Parameters
| Name | Type | Description |
|---|---|---|
value | String | The string value of the identifier to represent. A null reference ( |
nodeNamespace | OpcNamespace | The namespace that this identifier should refer to. |
pathElements | params OpcName[] | The elements of the OpcNamePath to use as the logical ( |
OpcNodeId(OpcNodeId)
Initializes a new instance of the OpcNodeId class using the other specified.
public OpcNodeId(OpcNodeId other)Public Sub New(other As OpcNodeId)Parameters
| Name | Type | Description |
|---|---|---|
other | OpcNodeId | The OpcNodeId from that a deep copy is to be created. |
Exceptions
| Exception | Condition |
|---|---|
| Argument | The other is a null reference ( |
Fields
DefaultSeparator
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.
public static readonly char DefaultSeparatorPublic Shared ReadOnly DefaultSeparator As CharField value
DefaultSeparatorOfPath
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.
public static readonly char DefaultSeparatorOfPathPublic Shared ReadOnly DefaultSeparatorOfPath As CharField value
Properties
Factory
Gets or sets the globally used OpcNodeIdFactory to generate new instances of the OpcNodeId class.
public static OpcNodeIdFactory Factory { get; set; }Public Shared Property Factory As OpcNodeIdFactoryProperty value
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.
public bool IsAbsolute { get; }Public ReadOnly Property IsAbsolute As BooleanProperty value
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.
public bool IsNull { get; }Public ReadOnly Property IsNull As BooleanProperty value
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.
public OpcNamespace Namespace { get; }Public ReadOnly Property [Namespace] As OpcNamespaceProperty value
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.
public int NamespaceIndex { get; }Public ReadOnly Property NamespaceIndex As IntegerProperty value
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.
public Uri NamespaceUri { get; }Public ReadOnly Property NamespaceUri As UriProperty value
The Uri to that the OpcNodeId refers using the NamespaceIndex.
Null
Gets the default null node identifier.
public static OpcNodeId Null { get; }Public Shared ReadOnly Property Null As OpcNodeIdProperty value
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.
public OpcNodeIdFormat OriginalFormat { get; }Public ReadOnly Property OriginalFormat As OpcNodeIdFormatProperty value
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.
public string OriginalString { get; }Public ReadOnly Property OriginalString As StringProperty value
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.
public OpcNamePath Path { get; }Public ReadOnly Property Path As OpcNamePathProperty value
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
Gets an instance of the OpcNodeIdResolution class used to resolve node identifiers.
public static OpcNodeIdResolution Resolution { get; }Public Shared ReadOnly Property Resolution As OpcNodeIdResolutionProperty value
An instance of the OpcNodeIdResolution class.
Type
Gets the type of Value used to define the identifier.
public OpcNodeIdType Type { get; }Public ReadOnly Property Type As OpcNodeIdTypeProperty value
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.
public object Value { get; }Public ReadOnly Property Value As ObjectProperty value
A byte-array, Guid, uint or string value used to define the identifier.
ValueAsString
Gets the Value formatted as a string.
public string ValueAsString { get; }Public ReadOnly Property ValueAsString As StringProperty value
A string representing the textual representation of the Value.
Methods
Compare
Compares two specified OpcNodeId objects according to a specific comparison method.
public static int Compare(
OpcNodeId first,
OpcNodeId second,
OpcNodeIdComparison comparisonType = OpcNodeIdComparison.Default)Public Shared Function Compare(
first As OpcNodeId,
second As OpcNodeId,
comparisonType As OpcNodeIdComparison = OpcNodeIdComparison.Default) As IntegerParameters
| Name | Type | Description |
|---|---|---|
first | OpcNodeId | The first OpcNodeId to compare, or a null reference ( |
second | OpcNodeId | The second OpcNodeId to compare, or a null reference ( |
comparisonType | Opc | One of the members defined by the OpcOpc. |
Returns
A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(T)).
CompareTo
| Overload | Description |
|---|---|
| CompareTo( | Compares the current OpcNodeId with the other. |
| CompareTo( | Compares the current OpcNodeId with another OpcNodeId. |
| CompareTo( | Compares the current OpcNodeId with another OpcNodeId according to a specific comparison method. |
CompareTo(object)
Compares the current OpcNodeId with the other.
public int CompareTo(object other)Public Function CompareTo(other As Object) As IntegerParameters
| Name | Type | Description |
|---|---|---|
other | Object | The OpcNodeId to compare with this OpcNodeId. |
Returns
A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(object)).
Implements
CompareTo(OpcNodeId)
Compares the current OpcNodeId with another OpcNodeId.
public int CompareTo(OpcNodeId other)Public Function CompareTo(other As OpcNodeId) As IntegerParameters
| Name | Type | Description |
|---|---|---|
other | OpcNodeId | The OpcNodeId to compare with this OpcNodeId. |
Returns
A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(T)).
Implements
CompareTo(OpcNodeId, OpcNodeIdComparison)
Compares the current OpcNodeId with another OpcNodeId according to a specific comparison method.
public int CompareTo(OpcNodeId other, OpcNodeIdComparison comparisonType)Public Function CompareTo(
other As OpcNodeId,
comparisonType As OpcNodeIdComparison) As IntegerParameters
| Name | Type | Description |
|---|---|---|
other | OpcNodeId | The OpcNodeId to compare with this OpcNodeId. |
comparisonType | Opc | One of the members defined by the Opc |
Returns
A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(T)).
Equals
| Overload | Description |
|---|---|
| Equals( | Determines whether two specified OpcNodeId objects are equals. |
| Equals( | Determines whether two specified OpcNodeId objects are equals according to a specific comparison method. |
| Equals( | Determines whether the specified other is equal to this OpcNodeId. |
| Equals( | Determines whether the specified other is equal to this OpcNodeId. |
| Equals( | Determines whether the specified OpcNodeId object is equals to this instance according to a specific comparison method. |
Equals(OpcNodeId, OpcNodeId)
Determines whether two specified OpcNodeId objects are equals.
public static bool Equals(OpcNodeId first, OpcNodeId second)Public Shared Function Equals(
first As OpcNodeId,
second As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
first | OpcNodeId | The first OpcNodeId to compare, or a null reference ( |
second | OpcNodeId | The second OpcNodeId to compare, or a null reference ( |
Returns
The value true if the first is equals to the second; otherwise the value false.
Equals(OpcNodeId, OpcNodeId, OpcNodeIdComparison)
Determines whether two specified OpcNodeId objects are equals according to a specific comparison method.
public static bool Equals(
OpcNodeId first,
OpcNodeId second,
OpcNodeIdComparison comparisonType)Public Shared Function Equals(
first As OpcNodeId,
second As OpcNodeId,
comparisonType As OpcNodeIdComparison) As BooleanParameters
| Name | Type | Description |
|---|---|---|
first | OpcNodeId | The first OpcNodeId to compare, or a null reference ( |
second | OpcNodeId | The second OpcNodeId to compare, or a null reference ( |
comparisonType | Opc | One of the members defined by the Opc |
Returns
The value true if the first is equals to the second; otherwise the value false.
Equals(object)
Determines whether the specified other is equal to this OpcNodeId.
public override bool Equals(object other)Public Overrides Function Equals(other As Object) As BooleanParameters
| Name | Type | Description |
|---|---|---|
other | Object | The OpcNodeId to compare to the current OpcNodeId. |
Returns
The value true if the specified OpcNodeId is equal to the current OpcNodeId; otherwise the value false.
Overrides
Equals(OpcNodeId)
Determines whether the specified other is equal to this OpcNodeId.
public bool Equals(OpcNodeId other)Public Function Equals(other As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
other | OpcNodeId | The OpcNodeId to compare to the current OpcNodeId. |
Returns
The value true if the specified OpcNodeId is equal to the current OpcNodeId; otherwise the value false.
Implements
Equals(OpcNodeId, OpcNodeIdComparison)
Determines whether the specified OpcNodeId object is equals to this instance according to a specific comparison method.
public bool Equals(OpcNodeId other, OpcNodeIdComparison comparisonType)Public Function Equals(
other As OpcNodeId,
comparisonType As OpcNodeIdComparison) As BooleanParameters
| Name | Type | Description |
|---|---|---|
other | OpcNodeId | The OpcNodeId to compare to this instance. |
comparisonType | Opc | One of the members defined by the Opc |
Returns
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.
public OpcNodeId ExcludePath()Public Function ExcludePath() As OpcNodeIdReturns
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
Retrieves a hash code for this OpcNodeId.
public override int GetHashCode()Public Overrides Function GetHashCode() As IntegerReturns
An int that contains the hash code for the OpcNodeId.
Overrides
IsNullOrEmpty
Indicates whether the specified OpcNodeId is null or its Value is null, default or an empty string ("").
public static bool IsNullOrEmpty(OpcNodeId identifier)Public Shared Function IsNullOrEmpty(identifier As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
identifier | OpcNodeId | The OpcNodeId to test. |
Returns
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
| Overload | Description |
|---|---|
| Of( | Creates a new OpcNodeId instance from the name specified. |
| Of( | Creates a new parent-child related OpcNodeId instance from the name and parentNodeId specified. |
| Of( | Creates a new parent-child related OpcNodeId instance from the name and parentNodeId specified. |
Exceptions (all overloads)
| Exception | Condition |
|---|---|
| Argument | The name does not provide a Value nor a NamespaceIndex from that a OpcNodeId can be created ( |
Of(OpcName)
Creates a new OpcNodeId instance from the name specified.
public static OpcNodeId Of(OpcName name)Public Shared Function [Of](name As OpcName) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
name | OpcName | The OpcName its Value and NamespaceIndex is used to create a new OpcNodeId of the type String. |
Returns
A new instance of the OpcNodeId created from the Value and NamespaceIndex of the name specified.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The name is a null reference ( |
Of(OpcName, OpcNodeId)
Creates a new parent-child related OpcNodeId instance from the name and parentNodeId specified.
public static OpcNodeId Of(OpcName name, OpcNodeId parentNodeId)Public Shared Function [Of](
name As OpcName,
parentNodeId As OpcNodeId) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
name | OpcName | The OpcName its Value and NamespaceIndex is used to create a new OpcNodeId of the type String. |
parentNodeId | OpcNodeId | The OpcNodeId of the parent node its identifier is to be integrated into the new node identifier. |
Returns
A new instance of the OpcNodeId created from the Value and NamespaceIndex of the name specified.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The name or parentNodeId is a null reference ( |
Of(OpcName, OpcNodeId, char)
Creates a new parent-child related OpcNodeId instance from the name and parentNodeId specified.
public static OpcNodeId Of(OpcName name, OpcNodeId parentNodeId, char separator)Public Shared Function [Of](
name As OpcName,
parentNodeId As OpcNodeId,
separator As Char) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
name | OpcName | The OpcName its Value and NamespaceIndex is used to create a new OpcNodeId of the type String. |
parentNodeId | OpcNodeId | The OpcNodeId of the parent node its identifier is to be integrated into the new node identifier. |
separator | Char | The char used to separate the child node identifier from the parentNodeId. |
Returns
A new instance of the OpcNodeId created from the Value and NamespaceIndex of the name specified.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The name or parentNodeId is a null reference ( |
Remarks
In case there the parentNodeId ends with the separator specified it will be not adopted by the newly created node identifier.
Parse
Converts a node identifier string to a OpcNodeId instance.
public static OpcNodeId Parse(string value)Public Shared Function Parse(value As String) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
value | String | A string that contains a node identifier. |
Returns
An instance of the OpcNodeId class.
Exceptions
| Exception | Condition |
|---|---|
| FormatException | The 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.
public OpcNodeId Resolve(IOpcNamespaceResolver resolver)Public Function Resolve(resolver As IOpcNamespaceResolver) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
resolver | IOpc | An instance implementing the IOpc |
Returns
A deep copy of this OpcNodeId using either the resolved namespace or the same namespace as this node identifier.
Exceptions
| Exception | Condition |
|---|---|
| Argument | The resolver is a null reference ( |
ToString
| Overload | Description |
|---|---|
| ToString() | Returns a string representing the node identifier. |
| ToString( | Returns a string representing the node identifier in the format specified. |
ToString()
Returns a string representing the node identifier.
public override string ToString()Public Overrides Function ToString() As StringReturns
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(OpcNodeIdFormat)
Returns a string representing the node identifier in the format specified.
public string ToString(OpcNodeIdFormat format)Public Function ToString(format As OpcNodeIdFormat) As StringParameters
| Name | Type | Description |
|---|---|---|
format | OpcNodeIdFormat | One of the formatting styles defined by the OpcNodeIdFormat enumeration. |
Returns
A string formatted using the format specified.
TryParse
Determines whether a string is a valid node identifier.
public static bool TryParse(string value, out OpcNodeId nodeId)Public Shared Function TryParse(value As String, nodeId As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
value | String | The string to validate. |
nodeId | out OpcNodeId | The OpcNodeId version of the string. |
Returns
The value true, if value is a valid node identifier; otherwise the value false.
UriIdentifier
Retrieves the Value of the nodeId as an Uri.
public static Uri UriIdentifier(OpcNodeId nodeId)Public Shared Function UriIdentifier(nodeId As OpcNodeId) As UriParameters
| Name | Type | Description |
|---|---|---|
nodeId | OpcNodeId | The OpcNodeId from its Value an Uri is to be retrieved. |
Returns
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
| Exception | Condition |
|---|---|
| Argument | The nodeId is a null reference ( |
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
| Overload | Description |
|---|---|
| WithPath( | Defines a new OpcNodeId using the Value, Namespace and Path of this OpcNodeId by combining this Path with the path specified. |
| WithPath( | 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.
public OpcNodeId WithPath(OpcNamePath path)Public Function WithPath(path As OpcNamePath) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
path | OpcNamePath | The logical ( |
Returns
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.
public OpcNodeId WithPath(params OpcName[] pathElements)Public Function WithPath(ParamArray pathElements As OpcName()) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
pathElements | params OpcName[] | The elements of the OpcNamePath to use as the logical ( |
Returns
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
Returns a value indicating whether two instance of OpcNodeId are equal.
public static bool operator ==(OpcNodeId left, OpcNodeId right)Public Shared Operator =(left As OpcNodeId, right As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
left | OpcNodeId | The first OpcNodeId to compare. |
right | OpcNodeId | The second OpcNodeId to compare. |
Returns
The value true if left and right are equal; otherwise the value false.
Explicit
| Overload | Description |
|---|---|
| explicit operator NodeId( | Converts a OpcNodeId to an NodeId object. |
| explicit operator ExpandedNodeId( | Converts a OpcNodeId to an ExpandedNodeId object. |
explicit operator NodeId(OpcNodeId)
Converts a OpcNodeId to an NodeId object.
[CLSCompliant(false)]
public static explicit operator NodeId(OpcNodeId value)<CLSCompliant(False)>
Public Shared Narrowing Operator CType(value As OpcNodeId) As NodeIdParameters
| Name | Type | Description |
|---|---|---|
value | OpcNodeId | A OpcNodeId that represents the node id. |
Returns
NodeId
An instance of the NodeId class initialized from the value.
explicit operator ExpandedNodeId(OpcNodeId)
Converts a OpcNodeId to an ExpandedNodeId object.
[CLSCompliant(false)]
public static explicit operator ExpandedNodeId(OpcNodeId value)<CLSCompliant(False)>
Public Shared Narrowing Operator CType(value As OpcNodeId) As ExpandedNodeIdParameters
| Name | Type | Description |
|---|---|---|
value | OpcNodeId | A OpcNodeId that represents the node id. |
Returns
ExpandedNodeId
An instance of the ExpandedNodeId class initialized from the value.
GreaterThan
Determines whether the first specified OpcNodeId object is greater than the second specified OpcNodeId object.
public static bool operator >(OpcNodeId left, OpcNodeId right)Public Shared Operator >(left As OpcNodeId, right As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
left | OpcNodeId | The first OpcNodeId object. |
right | OpcNodeId | The second OpcNodeId object. |
Returns
The value true if left is greater than right; otherwise, false.
GreaterThanOrEqual
Determines whether the first specified OpcNodeId object is greater than or equal to the second specified OpcNodeId object.
public static bool operator >=(OpcNodeId left, OpcNodeId right)Public Shared Operator >=(left As OpcNodeId, right As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
left | OpcNodeId | The first OpcNodeId object. |
right | OpcNodeId | The second OpcNodeId object. |
Returns
The value true if left is greater than or equal to right; otherwise, false.
Implicit
| Overload | Description |
|---|---|
| implicit operator OpcNodeId( | Converts a string to an OpcNodeId object. |
| implicit operator OpcNodeId( | Converts a int to an OpcNodeId object. |
| implicit operator OpcNodeId( | Converts a NodeId to an OpcNodeId object. |
| implicit operator OpcNodeId( | Converts a ExpandedNodeId to an OpcNodeId object. |
implicit operator OpcNodeId(string)
Converts a string to an OpcNodeId object.
public static implicit operator OpcNodeId(string value)Public Shared Widening Operator CType(value As String) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
value | String | A string that represents the node id. |
Returns
An instance of the OpcNodeId class initialized from the value.
implicit operator OpcNodeId(int)
Converts a int to an OpcNodeId object.
public static implicit operator OpcNodeId(int value)Public Shared Widening Operator CType(value As Integer) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
value | Int32 | A int that represents the node id. |
Returns
An instance of the OpcNodeId class initialized from the value.
implicit operator OpcNodeId(NodeId)
Converts a NodeId to an OpcNodeId object.
[CLSCompliant(false)]
public static implicit operator OpcNodeId(NodeId value)<CLSCompliant(False)>
Public Shared Widening Operator CType(value As NodeId) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
value | NodeId | A NodeId that represents the node id. |
Returns
An instance of the OpcNodeId class initialized from the value.
implicit operator OpcNodeId(ExpandedNodeId)
Converts a ExpandedNodeId to an OpcNodeId object.
[CLSCompliant(false)]
public static implicit operator OpcNodeId(ExpandedNodeId value)<CLSCompliant(False)>
Public Shared Widening Operator CType(value As ExpandedNodeId) As OpcNodeIdParameters
| Name | Type | Description |
|---|---|---|
value | ExpandedNodeId | A ExpandedNodeId that represents expanded the node id. |
Returns
An instance of the OpcNodeId class initialized from the value.
Inequality
Returns a value indicating whether two instances of OpcNodeId are not equal.
public static bool operator !=(OpcNodeId left, OpcNodeId right)Public Shared Operator <>(left As OpcNodeId, right As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
left | OpcNodeId | The first OpcNodeId to compare. |
right | OpcNodeId | The second OpcNodeId to compare. |
Returns
The value true if left and right are not equal; otherwise the value false.
LessThan
Determines whether the first specified OpcNodeId object is less than the second specified OpcNodeId object.
public static bool operator <(OpcNodeId left, OpcNodeId right)Public Shared Operator <(left As OpcNodeId, right As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
left | OpcNodeId | The first OpcNodeId object. |
right | OpcNodeId | The second OpcNodeId object. |
Returns
The value true if left is less than right; otherwise the value false.
LessThanOrEqual
Determines whether the first specified OpcNodeId object is less than or equal to the second OpcNodeId object.
public static bool operator <=(OpcNodeId left, OpcNodeId right)Public Shared Operator <=(left As OpcNodeId, right As OpcNodeId) As BooleanParameters
| Name | Type | Description |
|---|---|---|
left | OpcNodeId | The first OpcNodeId object. |
right | OpcNodeId | The second OpcNodeId object. |
Returns
The value true if left is less than or equal to right; otherwise the value false.

