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

A class that stores a relative path string More...

Inherits IFormattable.

Classes

class  Element
 A element in a relative path string. More...
 

Public Types

enum  ElementType { AnyHierarchical = 0x01, AnyComponent = 0x02, ForwardReference = 0x03, InverseReference = 0x04 }
 The type of relative path element. More...
 

Public Member Functions

 RelativePathFormatter (RelativePath relativePath, ITypeTable typeTree)
 Initializes the object the default values. More...
 
 RelativePathFormatter ()
 Initializes the object the default values. More...
 
void UpdateNamespaceTable (NamespaceTable currentTable, NamespaceTable targetTable)
 Updates the namespace table with URI used in the relative path. More...
 
void TranslateNamespaceIndexes (NamespaceTable currentTable, NamespaceTable targetTable)
 Updates the path to use the indexes from the target table. More...
 
override string ToString ()
 Formats the relative path as a string. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Formats the relative path as a string. More...
 

Static Public Member Functions

static bool IsEmpty (RelativePathFormatter relativePath)
 Returns true if the relative path does not specify any elements. More...
 
static RelativePathFormatter Parse (string textToParse, NamespaceTable currentTable, NamespaceTable targetTable)
 Parses a string representing a relative path and translates the namespace indexes. More...
 
static RelativePathFormatter Parse (string textToParse)
 Parses a string representing a relative path. More...
 

Properties

List< ElementElements [get]
 The elements in the relative path. More...
 

Detailed Description

A class that stores a relative path string

Member Enumeration Documentation

The type of relative path element.

Enumerator
AnyHierarchical 

Any hierarchial reference should be followed ('/').

AnyComponent 

Any component reference should be followed ('.').

ForwardReference 

The forward reference identified by the browse name should be followed.

InverseReference 

The inverse reference identified by the browse name should be followed.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.RelativePathFormatter.RelativePathFormatter ( RelativePath  relativePath,
ITypeTable  typeTree 
)
inline

Initializes the object the default values.

UnifiedAutomation.UaBase.RelativePathFormatter.RelativePathFormatter ( )
inline

Initializes the object the default values.

Member Function Documentation

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

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

static RelativePathFormatter UnifiedAutomation.UaBase.RelativePathFormatter.Parse ( string  textToParse,
NamespaceTable  currentTable,
NamespaceTable  targetTable 
)
inlinestatic

Parses a string representing a relative path and translates the namespace indexes.

Parses a string representing a relative path.

Exceptions
StatusExceptionThrown if any errors occur during parsing
static RelativePathFormatter UnifiedAutomation.UaBase.RelativePathFormatter.Parse ( string  textToParse)
inlinestatic

Parses a string representing a relative path.

Parses a string representing a relative path.

Exceptions
StatusExceptionThrown if any errors occur during parsing
override string UnifiedAutomation.UaBase.RelativePathFormatter.ToString ( )
inline

Formats the relative path as a string.

Formats the relative path as a string.

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

Formats the relative path as a string.

Formats the relative path as a string.

Parameters
format(Unused) Always pass null
formatProvider(Unused) Always pass null
Exceptions
FormatExceptionThrown if non-null parameters are passed
void UnifiedAutomation.UaBase.RelativePathFormatter.TranslateNamespaceIndexes ( NamespaceTable  currentTable,
NamespaceTable  targetTable 
)
inline

Updates the path to use the indexes from the target table.

Parameters
currentTableThe NamespaceTable which the RelativePathString currently references
targetTableThe NamespaceTable which the RelativePathString should reference
void UnifiedAutomation.UaBase.RelativePathFormatter.UpdateNamespaceTable ( NamespaceTable  currentTable,
NamespaceTable  targetTable 
)
inline

Updates the namespace table with URI used in the relative path.

Parameters
currentTableThe current table.
targetTableThe target table.

Property Documentation

List<Element> UnifiedAutomation.UaBase.RelativePathFormatter.Elements
get

The elements in the relative path.

The elements in the relative path.


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