C# Class Opc.Ua.RelativePathFormatter

A class that stores a relative path string
Inheritance: IFormattable
Mostrar archivo Open project: OPCFoundation/UA-.NETStandardLibrary Class Usage Examples

Public Methods

Method Description
IsEmpty ( RelativePathFormatter relativePath ) : bool

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

Parse ( string textToParse ) : RelativePathFormatter

Parses a string representing a relative path.

Parses a string representing a relative path.

Parse ( string textToParse, Opc.Ua.NamespaceTable currentTable, Opc.Ua.NamespaceTable targetTable ) : RelativePathFormatter

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

Parses a string representing a relative path.

RelativePathFormatter ( ) : System

Initializes the object the default values.

RelativePathFormatter ( RelativePath relativePath, ITypeTable typeTree ) : System

Initializes the object the default values.

ToString ( ) : string

Formats the relative path as a string.

Formats the relative path as a string.

ToString ( string format, IFormatProvider formatProvider ) : string

Formats the relative path as a string.

Formats the relative path as a string.

TranslateNamespaceIndexes ( Opc.Ua.NamespaceTable currentTable, Opc.Ua.NamespaceTable targetTable ) : void

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

UpdateNamespaceTable ( Opc.Ua.NamespaceTable currentTable, Opc.Ua.NamespaceTable targetTable ) : void

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

Method Details

IsEmpty() public static method

Returns true if the relative path does not specify any elements.
public static IsEmpty ( RelativePathFormatter relativePath ) : bool
relativePath RelativePathFormatter
return bool

Parse() public static method

Parses a string representing a relative path.
Parses a string representing a relative path.
Thrown if any errors occur during parsing
public static Parse ( string textToParse ) : RelativePathFormatter
textToParse string
return RelativePathFormatter

Parse() public static method

Parses a string representing a relative path and translates the namespace indexes.
Parses a string representing a relative path.
Thrown if any errors occur during parsing
public static Parse ( string textToParse, Opc.Ua.NamespaceTable currentTable, Opc.Ua.NamespaceTable targetTable ) : RelativePathFormatter
textToParse string
currentTable Opc.Ua.NamespaceTable
targetTable Opc.Ua.NamespaceTable
return RelativePathFormatter

RelativePathFormatter() public method

Initializes the object the default values.
public RelativePathFormatter ( ) : System
return System

RelativePathFormatter() public method

Initializes the object the default values.
public RelativePathFormatter ( RelativePath relativePath, ITypeTable typeTree ) : System
relativePath RelativePath
typeTree ITypeTable
return System

ToString() public method

Formats the relative path as a string.
Formats the relative path as a string.
public ToString ( ) : string
return string

ToString() public method

Formats the relative path as a string.
Formats the relative path as a string.
Thrown if non-null parameters are passed
public ToString ( string format, IFormatProvider formatProvider ) : string
format string (Unused) Always pass null
formatProvider IFormatProvider (Unused) Always pass null
return string

TranslateNamespaceIndexes() public method

Updates the path to use the indexes from the target table.
public TranslateNamespaceIndexes ( Opc.Ua.NamespaceTable currentTable, Opc.Ua.NamespaceTable targetTable ) : void
currentTable Opc.Ua.NamespaceTable The NamespaceTable which the RelativePathString currently references
targetTable Opc.Ua.NamespaceTable The NamespaceTable which the RelativePathString should reference
return void

UpdateNamespaceTable() public method

Updates the namespace table with URI used in the relative path.
public UpdateNamespaceTable ( Opc.Ua.NamespaceTable currentTable, Opc.Ua.NamespaceTable targetTable ) : void
currentTable Opc.Ua.NamespaceTable The current table.
targetTable Opc.Ua.NamespaceTable The target table.
return void