.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaBase.ExpandedNodeId Class Reference

Class representing an identifier for a node in a UA server address space qualified with a complete namespace string. More...

Inherits IComparable, IFormattable, and ICloneable.

Public Member Functions

 ExpandedNodeId (uint identifier, ushort namespaceIndex)
 Creates a node id. More...
 
 ExpandedNodeId (uint identifier, string namespaceUri)
 Creates a node id. More...
 
 ExpandedNodeId (uint identifier, ushort namespaceIndex, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (uint identifier, string namespaceUri, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (string identifier, ushort namespaceIndex)
 Creates a node id. More...
 
 ExpandedNodeId (string identifier, string namespaceUri)
 Creates a node id. More...
 
 ExpandedNodeId (string identifier, ushort namespaceIndex, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (string identifier, string namespaceUri, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (Guid identifier, ushort namespaceIndex)
 Creates a node id. More...
 
 ExpandedNodeId (Guid identifier, string namespaceUri)
 Creates a node id. More...
 
 ExpandedNodeId (Guid identifier, ushort namespaceIndex, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (Guid identifier, string namespaceUri, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (byte[] identifier, ushort namespaceIndex)
 Creates a node id. More...
 
 ExpandedNodeId (byte[] identifier, string namespaceUri)
 Creates a node id. More...
 
 ExpandedNodeId (byte[] identifier, ushort namespaceIndex, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (byte[] identifier, string namespaceUri, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (IdType idType, object identifier, ushort namespaceIndex)
 Creates a node id. More...
 
 ExpandedNodeId (IdType idType, object identifier, string namespaceUri)
 Creates a node id. More...
 
 ExpandedNodeId (IdType idType, object identifier, string namespaceUri, uint serverIndex)
 Creates a node id. More...
 
 ExpandedNodeId (IdType idType, object identifier, ushort namespaceIndex, uint serverIndex)
 Creates a node id. More...
 
object Clone ()
 Creates a deep copy of the object. More...
 
override bool Equals (object obj)
 Returns true if the object is equal to the instance. More...
 
override int GetHashCode ()
 Returns a hash code for the instance. More...
 
int CompareTo (object obj)
 Compares the instance to another object. More...
 
override string ToString ()
 Formats the object as a string. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Formats the object as a string. More...
 
string Format ()
 Formats an expanded node id as a string. More...
 
void Format (StringBuilder buffer)
 Formats the node ids as string and adds it to the buffer. More...
 
NodeId ToNodeId (IList< string > namespaceUris)
 Converts an ExpandedNodeId to a NodeId using the given namespaceUris. More...
 

Static Public Member Functions

static new bool Equals (object value1, object value2)
 Determines whether the specified System.Object, is equal to this instance. More...
 
static void Format (StringBuilder buffer, object identifier, IdType identifierType, ushort namespaceIndex, string namespaceUri, uint serverIndex)
 Formats the node ids as string and adds it to the buffer. More...
 
static ExpandedNodeId Parse (string text)
 Parses an expanded node id string, translates any namespace indexes, and returns the result. More...
 
static ExpandedNodeId Parse (string text, NamespaceTable currentNamespaces, NamespaceTable targetNamespaces)
 Parses an expanded node id string, translates any namespace indexes, and returns the result. More...
 
static NodeId ToNodeId (ExpandedNodeId nodeId, IList< string > namespaceUris)
 Converts an ExpandedNodeId to a NodeId using the given namespaceUris. More...
 
static bool operator== (ExpandedNodeId node1, ExpandedNodeId node2)
 Implements the operator ==. More...
 
static bool operator!= (ExpandedNodeId node1, ExpandedNodeId node2)
 Implements the operator !=. More...
 

Static Public Attributes

static readonly ExpandedNodeId Null = new ExpandedNodeId()
 An ExpandedNodeId that represents a Null value. More...
 

Properties

uint ServerIndex [get, set]
 The index of the server uri. More...
 
string NamespaceUri [get, set]
 The absolute namespace uri (NamespaceIndex is ignored if specified). More...
 
ushort NamespaceIndex [get, set]
 The index of the namespace uri (ignored if NamespaceUri is specified). More...
 
IdType IdType [get, set]
 The type of identifier. More...
 
object Identifier [get, set]
 The actual identifier. More...
 
bool IsAbsolute [get]
 Gets a value indicating whether this instance is an absolute node id. More...
 

Detailed Description

Class representing an identifier for a node in a UA server address space qualified with a complete namespace string.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( uint  identifier,
ushort  namespaceIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceIndexIndex of the namespace.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( uint  identifier,
string  namespaceUri 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceUriThe namespace URI.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( uint  identifier,
ushort  namespaceIndex,
uint  serverIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceIndexIndex of the namespace.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( uint  identifier,
string  namespaceUri,
uint  serverIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceUriThe namespace URI.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( string  identifier,
ushort  namespaceIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceIndexIndex of the namespace.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( string  identifier,
string  namespaceUri 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceUriThe namespace URI.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( string  identifier,
ushort  namespaceIndex,
uint  serverIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceIndexIndex of the namespace.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( string  identifier,
string  namespaceUri,
uint  serverIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceUriThe namespace URI.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( Guid  identifier,
ushort  namespaceIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceIndexIndex of the namespace.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( Guid  identifier,
string  namespaceUri 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceUriThe namespace URI.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( Guid  identifier,
ushort  namespaceIndex,
uint  serverIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceIndexIndex of the namespace.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( Guid  identifier,
string  namespaceUri,
uint  serverIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceUriThe namespace URI.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( byte[]  identifier,
ushort  namespaceIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceIndexIndex of the namespace.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( byte[]  identifier,
string  namespaceUri 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceUriThe namespace URI.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( byte[]  identifier,
ushort  namespaceIndex,
uint  serverIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceIndexIndex of the namespace.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( byte[]  identifier,
string  namespaceUri,
uint  serverIndex 
)

Creates a node id.

Parameters
identifierThe identifier.
namespaceUriThe namespace URI.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( IdType  idType,
object  identifier,
ushort  namespaceIndex 
)

Creates a node id.

Parameters
idTypeType of the id.
identifierThe identifier.
namespaceIndexIndex of the namespace.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( IdType  idType,
object  identifier,
string  namespaceUri 
)

Creates a node id.

Parameters
idTypeType of the id.
identifierThe identifier.
namespaceUriThe namespace URI.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( IdType  idType,
object  identifier,
string  namespaceUri,
uint  serverIndex 
)

Creates a node id.

Parameters
idTypeType of the id.
identifierThe identifier.
namespaceUriThe namespace URI.
serverIndexIndex of the server.
UnifiedAutomation.UaBase.ExpandedNodeId.ExpandedNodeId ( IdType  idType,
object  identifier,
ushort  namespaceIndex,
uint  serverIndex 
)

Creates a node id.

Parameters
idTypeType of the id.
identifierThe identifier.
namespaceIndexIndex of the namespace.
serverIndexIndex of the server.

Member Function Documentation

object UnifiedAutomation.UaBase.ExpandedNodeId.Clone ( )

Creates a deep copy of the object.

int UnifiedAutomation.UaBase.ExpandedNodeId.CompareTo ( object  obj)

Compares the instance to another object.

Parameters
objThe object to compare to this object
Returns
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
Value Meaning
Less than zero This instance is less than obj .
Zero This instance is equal to obj .
Greater than zero This instance is greater than obj .
static new bool UnifiedAutomation.UaBase.ExpandedNodeId.Equals ( object  value1,
object  value2 
)
static

Determines whether the specified System.Object, is equal to this instance.

Parameters
value1The System.Object to compare with this instance.
value2The value2.
Returns
true if the specified System.Object is equal to this instance; otherwise, false.
override bool UnifiedAutomation.UaBase.ExpandedNodeId.Equals ( object  obj)

Returns true if the object is equal to the instance.

Parameters
objThe System.Object to compare with this instance.
Returns
true if the specified System.Object is equal to this instance; otherwise, false.
Exceptions
T:System.NullReferenceExceptionThe obj parameter is null.
string UnifiedAutomation.UaBase.ExpandedNodeId.Format ( )

Formats an expanded node id as a string.

void UnifiedAutomation.UaBase.ExpandedNodeId.Format ( StringBuilder  buffer)

Formats the node ids as string and adds it to the buffer.

Parameters
bufferThe buffer.
static void UnifiedAutomation.UaBase.ExpandedNodeId.Format ( StringBuilder  buffer,
object  identifier,
IdType  identifierType,
ushort  namespaceIndex,
string  namespaceUri,
uint  serverIndex 
)
static

Formats the node ids as string and adds it to the buffer.

Parameters
bufferThe buffer.
identifierThe identifier.
identifierTypeType of the identifier.
namespaceIndexIndex of the namespace.
namespaceUriThe namespace URI.
serverIndexIndex of the server.
override int UnifiedAutomation.UaBase.ExpandedNodeId.GetHashCode ( )

Returns a hash code for the instance.

Returns
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
static bool UnifiedAutomation.UaBase.ExpandedNodeId.operator!= ( ExpandedNodeId  node1,
ExpandedNodeId  node2 
)
static

Implements the operator !=.

Parameters
node1The node1.
node2The node2.
Returns
The result of the operator.
static bool UnifiedAutomation.UaBase.ExpandedNodeId.operator== ( ExpandedNodeId  node1,
ExpandedNodeId  node2 
)
static

Implements the operator ==.

Parameters
node1The node1.
node2The node2.
Returns
The result of the operator.
static ExpandedNodeId UnifiedAutomation.UaBase.ExpandedNodeId.Parse ( string  text)
static

Parses an expanded node id string, translates any namespace indexes, and returns the result.

Parameters
textThe text.
Returns
The new ExpandedNodeId.
static ExpandedNodeId UnifiedAutomation.UaBase.ExpandedNodeId.Parse ( string  text,
NamespaceTable  currentNamespaces,
NamespaceTable  targetNamespaces 
)
static

Parses an expanded node id string, translates any namespace indexes, and returns the result.

Parameters
textThe text.
currentNamespacesThe current namespaces.
targetNamespacesThe target namespaces.
Returns
The new ExpandedNodeId.
NodeId UnifiedAutomation.UaBase.ExpandedNodeId.ToNodeId ( IList< string >  namespaceUris)

Converts an ExpandedNodeId to a NodeId using the given namespaceUris.

Parameters
namespaceUrisThe namespace uris.
Returns
The new NodeId.
static NodeId UnifiedAutomation.UaBase.ExpandedNodeId.ToNodeId ( ExpandedNodeId  nodeId,
IList< string >  namespaceUris 
)
static

Converts an ExpandedNodeId to a NodeId using the given namespaceUris.

Parameters
nodeIdThe node id.
namespaceUrisThe namespace uris.
Returns
The new NodeId.
override string UnifiedAutomation.UaBase.ExpandedNodeId.ToString ( )

Formats the object as a string.

Returns
A System.String that represents this instance.
string UnifiedAutomation.UaBase.ExpandedNodeId.ToString ( string  format,
IFormatProvider  formatProvider 
)

Formats the object as a string.

Parameters
formatThe format.
formatProviderThe format provider.
Returns
A System.String that represents this instance.

Member Data Documentation

readonly ExpandedNodeId UnifiedAutomation.UaBase.ExpandedNodeId.Null = new ExpandedNodeId()
static

An ExpandedNodeId that represents a Null value.

Property Documentation

object UnifiedAutomation.UaBase.ExpandedNodeId.Identifier
getset

The actual identifier.

IdType UnifiedAutomation.UaBase.ExpandedNodeId.IdType
getset

The type of identifier.

bool UnifiedAutomation.UaBase.ExpandedNodeId.IsAbsolute
get

Gets a value indicating whether this instance is an absolute node id.

true if this instance is an absolute node id; otherwise, false.

If false, then the instance can be safely cast to a NodeId.

ushort UnifiedAutomation.UaBase.ExpandedNodeId.NamespaceIndex
getset

The index of the namespace uri (ignored if NamespaceUri is specified).

string UnifiedAutomation.UaBase.ExpandedNodeId.NamespaceUri
getset

The absolute namespace uri (NamespaceIndex is ignored if specified).

uint UnifiedAutomation.UaBase.ExpandedNodeId.ServerIndex
getset

The index of the server uri.


The documentation for this class was generated from the following file: