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.
	RelativePath (NodeId referenceTypeId, QualifiedName browseName)
	Creates a relative path to follow the forward reference type to find the specified browse name.
	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.
string	Format (ITypeTable typeTree)
	Formats the relative path as a string.
	RelativePath ()
	The default constructor.
virtual void	Encode (IEncoder encoder)
virtual void	Decode (IDecoder decoder)
virtual bool	IsEqual (IEncodeable encodeable)
virtual object	Clone ()
Public Member Functions inherited from UnifiedAutomation.UaBase.IEncodeable
void	Encode (IEncoder encoder)
	Encodes the object in a stream.
void	Decode (IDecoder decoder)
	Decodes the object from a stream.

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

Properties
RelativePathElementCollection	Elements [get, set]
	A list of elements in the path.
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.
ExpandedNodeId	BinaryEncodingId [get]
	Returns the UA type identifier for the default binary encoding for the type.
ExpandedNodeId	XmlEncodingId [get]
	Returns the UA type identifier for the default XML encoding for the type.

Detailed Description

A class that stores a relative path

A relative path constructed from reference types and browse names.

<exclude>

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.RelativePath.RelativePath

(

QualifiedName

browseName

)

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

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

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
	)

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

UnifiedAutomation.UaBase.RelativePath.RelativePath

(

)

The default constructor.

Member Function Documentation

string UnifiedAutomation.UaBase.RelativePath.Format

(

ITypeTable

typeTree

)

Formats the relative path as a string.

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

static

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

static RelativePath UnifiedAutomation.UaBase.RelativePath.Parse ( string  browsePath )

static

Parses a relative path formatted as a string.

Parameters

browsePath

The 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  )

static

Parses a relative path formatted as a string.

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

static

Parses a relative path formatted as a string.

Property Documentation

RelativePathElementCollection UnifiedAutomation.UaBase.RelativePath.Elements

getset

A list of elements in the path.

---

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

• C:/work/uasdknet/src/UaBase/BuiltIn/RelativePath.cs
• C:/work/uasdknet/src/UaBase/Generated/Opc.Ua.DataTypes.cs