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

A class that stores a relative path More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 RelativePath (QualifiedName browseName)
 Creates a relative path to follow any hierarchial references to find the specified browse name. More...
 
 RelativePath (NodeId referenceTypeId, QualifiedName browseName)
 Creates a relative path to follow the forward reference type to find the specified browse name. More...
 
 RelativePath (NodeId referenceTypeId, bool isInverse, bool includeSubtypes, QualifiedName browseName)
 Creates a relative path to follow the forward reference type to find the specified browse name. More...
 
string Format (ITypeTable typeTree)
 Formats the relative path as a string. More...
 
 RelativePath ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
 
virtual void Decode (IDecoder decoder)
 
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 
 

Static Public Member Functions

static bool IsEmpty (RelativePath relativePath)
 Returns true if the relative path does not specify any elements. More...
 
static RelativePath Parse (string browsePath)
 Parses a relative path formatted as a string. More...
 
static RelativePath Parse (string browsePath, ITypeTable typeTree)
 Parses a relative path formatted as a string. More...
 
static RelativePath Parse (string browsePath, ITypeTable typeTree, NamespaceTable currentTable, NamespaceTable targetTable)
 Parses a relative path formatted as a string. More...
 

Properties

RelativePathElementCollection Elements [get, set]
  More...
 
virtual ExpandedNodeId TypeId [get]
 
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
 
virtual ExpandedNodeId XmlEncodingId [get]
 
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

A class that stores a relative path

Defines a sequence of References and BrowseNames to follow.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.RelativePath.RelativePath ( QualifiedName  browseName)
inline

Creates a relative path to follow any hierarchial references to find the specified browse name.

UnifiedAutomation.UaBase.RelativePath.RelativePath ( NodeId  referenceTypeId,
QualifiedName  browseName 
)
inline

Creates a relative path to follow the forward reference type to find the specified browse name.

UnifiedAutomation.UaBase.RelativePath.RelativePath ( NodeId  referenceTypeId,
bool  isInverse,
bool  includeSubtypes,
QualifiedName  browseName 
)
inline

Creates a relative path to follow the forward reference type to find the specified browse name.

UnifiedAutomation.UaBase.RelativePath.RelativePath ( )
inline

The default constructor.

Member Function Documentation

string UnifiedAutomation.UaBase.RelativePath.Format ( ITypeTable  typeTree)
inline

Formats the relative path as a string.

static bool UnifiedAutomation.UaBase.RelativePath.IsEmpty ( RelativePath  relativePath)
inlinestatic

Returns true if the relative path does not specify any elements.

virtual bool UnifiedAutomation.UaBase.RelativePath.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns
static RelativePath UnifiedAutomation.UaBase.RelativePath.Parse ( string  browsePath)
inlinestatic

Parses a relative path formatted as a string.

Parameters
browsePathThe browse path.
Returns

The syntax of the string that can be parsed by this method is a sequence of elements with the form:

('/' | '.' | ('<' ('#" | '!') [ReferenceTypeName] '>'))[BrowseName]

Where the path starts with a reference type denoted by:

'/' indicates a hierarchical reference. '.' indicates an aggregates reference. '<' and '>' encloses a reference type with the specified name. '#' indicates that subtypes of the reference should not be followed. '!' indicates that a reverse reference should be followed.

The BrowseName and ReferenceTypeName have a syntax like:

([NamespaceIndex]:)[Name]

NamespaceIndex is an unsigned integer. Name is any valid BrowseName.

The '&' is used to escape any special characters that appear in the Name. For example, the BrowseName '!Good&Bad' would be represented as '&!Good&&Bad'.

Examples of RelativePaths:

2:Block.Output

/2:Block&.Output /3:Truck.0:NodeVersion <1:ConnectedTo>1:Boiler/1:HeatSensor <!HasChild>1:Truck

static RelativePath UnifiedAutomation.UaBase.RelativePath.Parse ( string  browsePath,
ITypeTable  typeTree 
)
inlinestatic

Parses a relative path formatted as a string.

static RelativePath UnifiedAutomation.UaBase.RelativePath.Parse ( string  browsePath,
ITypeTable  typeTree,
NamespaceTable  currentTable,
NamespaceTable  targetTable 
)
inlinestatic

Parses a relative path formatted as a string.

Property Documentation

RelativePathElementCollection UnifiedAutomation.UaBase.RelativePath.Elements
getset


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