UA Bundle SDK .NET  2.2.1.258
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.NodeId Class Reference

Represents a node id. More...

Inherits IComparable, IFormattable, and ICloneable.

Public Member Functions

 NodeId (uint id)
 Creates a node id. More...
 
 NodeId (uint id, ushort namespaceIndex)
 Creates a node id. More...
 
 NodeId (string id, ushort namespaceIndex)
 Creates a node id. More...
 
 NodeId (Guid id, ushort namespaceIndex)
 Creates a node id. More...
 
 NodeId (byte[] id, ushort namespaceIndex)
 Creates a node id. More...
 
 NodeId (IdType idType, object id, ushort namespaceIndex)
 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 a node id as a string. More...
 
void Format (StringBuilder buffer)
 Formats the node ids as string and adds it to the buffer. More...
 

Static Public Member Functions

static void Format (StringBuilder buffer, object identifier, IdType identifierType, ushort namespaceIndex)
 Formats the node ids as string and adds it to the buffer. More...
 
static NodeId Parse (string text)
 Parses the specified text and returns a node id. More...
 
static NodeId Parse (string text, NamespaceTable currentNamespaces, NamespaceTable targetNamespaces)
 Parses a node id string, translates any namespace indexes and returns the result. More...
 
static operator NodeId (uint id)
 Converts a uint to a Nodeid. More...
 
static implicit operator ExpandedNodeId (NodeId id)
 Converts a node id to an expanded node id. More...
 
static operator NodeId (ExpandedNodeId id)
 Converts an expanded node id to a node id. More...
 
static bool IsNull (NodeId nodeId)
 Returns true if the node id is a NULL node id. More...
 
static bool IsNull (ExpandedNodeId nodeId)
 Returns true if the node id is a NULL node id. More...
 
static ExpandedNodeId ToAbsoluteNodeId (NodeId nodeId, StringTable namespaceUris)
 Converts the NodeId to an absolute node id. More...
 
static bool operator== (NodeId node1, NodeId node2)
 Implements the operator ==. More...
 
static bool operator!= (NodeId node1, NodeId node2)
 Implements the operator !=. More...
 

Static Public Attributes

static readonly NodeId Null = new NodeId()
 A constant representing a NULL NodeId. More...
 

Properties

ushort NamespaceIndex [get, set]
 The index of the namespace uri. More...
 
IdType IdType [get, set]
 The type of identifier. More...
 
object Identifier [get, set]
 The actual identifier. More...
 

Detailed Description

Represents a node id.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.NodeId.NodeId ( uint  id)
inline

Creates a node id.

UnifiedAutomation.UaBase.NodeId.NodeId ( uint  id,
ushort  namespaceIndex 
)
inline

Creates a node id.

UnifiedAutomation.UaBase.NodeId.NodeId ( string  id,
ushort  namespaceIndex 
)
inline

Creates a node id.

UnifiedAutomation.UaBase.NodeId.NodeId ( Guid  id,
ushort  namespaceIndex 
)
inline

Creates a node id.

UnifiedAutomation.UaBase.NodeId.NodeId ( byte[]  id,
ushort  namespaceIndex 
)
inline

Creates a node id.

UnifiedAutomation.UaBase.NodeId.NodeId ( IdType  idType,
object  id,
ushort  namespaceIndex 
)
inline

Creates a node id.

Member Function Documentation

object UnifiedAutomation.UaBase.NodeId.Clone ( )
inline

Creates a deep copy of the object.

int UnifiedAutomation.UaBase.NodeId.CompareTo ( object  obj)
inline

Compares the instance to another object.

Parameters
objThe object to compare to this object
override bool UnifiedAutomation.UaBase.NodeId.Equals ( object  obj)
inline

Returns true if the object is equal to the instance.

string UnifiedAutomation.UaBase.NodeId.Format ( )
inline

Formats a node id as a string.

void UnifiedAutomation.UaBase.NodeId.Format ( StringBuilder  buffer)
inline

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

static void UnifiedAutomation.UaBase.NodeId.Format ( StringBuilder  buffer,
object  identifier,
IdType  identifierType,
ushort  namespaceIndex 
)
inlinestatic

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

override int UnifiedAutomation.UaBase.NodeId.GetHashCode ( )
inline

Returns a hash code for the instance.

static bool UnifiedAutomation.UaBase.NodeId.IsNull ( NodeId  nodeId)
inlinestatic

Returns true if the node id is a NULL node id.

Parameters
nodeIdThe node id.
Returns
true if the specified node id is null; otherwise, false.
static bool UnifiedAutomation.UaBase.NodeId.IsNull ( ExpandedNodeId  nodeId)
inlinestatic

Returns true if the node id is a NULL node id.

Parameters
nodeIdThe node id.
Returns
true if the specified node id is null; otherwise, false.
static implicit UnifiedAutomation.UaBase.NodeId.operator ExpandedNodeId ( NodeId  id)
inlinestatic

Converts a node id to an expanded node id.

Parameters
idThe id.
Returns
The result of the conversion.
static UnifiedAutomation.UaBase.NodeId.operator NodeId ( uint  id)
inlineexplicitstatic

Converts a uint to a Nodeid.

Parameters
idThe id.
Returns
The result of the conversion.
static UnifiedAutomation.UaBase.NodeId.operator NodeId ( ExpandedNodeId  id)
inlineexplicitstatic

Converts an expanded node id to a node id.

Parameters
idThe id.
Returns
The result of the conversion.
static bool UnifiedAutomation.UaBase.NodeId.operator!= ( NodeId  node1,
NodeId  node2 
)
inlinestatic

Implements the operator !=.

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

Implements the operator ==.

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

Parses the specified text and returns a node id.

static NodeId UnifiedAutomation.UaBase.NodeId.Parse ( string  text,
NamespaceTable  currentNamespaces,
NamespaceTable  targetNamespaces 
)
inlinestatic

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

static ExpandedNodeId UnifiedAutomation.UaBase.NodeId.ToAbsoluteNodeId ( NodeId  nodeId,
StringTable  namespaceUris 
)
inlinestatic

Converts the NodeId to an absolute node id.

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

Formats the object as a string.

string UnifiedAutomation.UaBase.NodeId.ToString ( string  format,
IFormatProvider  formatProvider 
)
inline

Formats the object as a string.

Member Data Documentation

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

A constant representing a NULL NodeId.

Property Documentation

object UnifiedAutomation.UaBase.NodeId.Identifier
getset

The actual identifier.

IdType UnifiedAutomation.UaBase.NodeId.IdType
getset

The type of identifier.

ushort UnifiedAutomation.UaBase.NodeId.NamespaceIndex
getset

The index of the namespace uri.


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