Reference

OpcRelativePath Members

Type

OpcRelativePath

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcRelativePath

6 overloads

Overload	Description
OpcRelativePath(IEnumerable<string>)	Initializes a new instance of the OpcRelativePath class with the pathElements specified to define a path following hierarchical references using the pathElements as the browse names of the nodes their path is to be expressed.
OpcRelativePath(params string[])	Initializes a new instance of the OpcRelativePath class with the pathElements specified to define a path following hierarchical references using the pathElements as the browse names of the nodes their path is to be expressed.
OpcRelativePath(IEnumerable<OpcName>)	Initializes a new instance of the OpcRelativePath class with the pathElements specified to define a path following hierarchical references using the pathElements as the browse names of the nodes their path is to be expressed.
OpcRelativePath(params OpcName[])	Initializes a new instance of the OpcRelativePath class with the pathElements specified to define a path following hierarchical references using the pathElements as the browse names of the nodes their path is to be expressed.
OpcRelativePath(IEnumerable<OpcRelativePathElement>)	Initializes a new instance of the OpcRelativePath class with the pathElements specified.
OpcRelativePath(params OpcRelativePathElement[])	Initializes a new instance of the OpcRelativePath class with the pathElements specified.

Exceptions (all overloads)

Exception	Condition
ArgumentNullException	The pathElements or one of its items is a null reference (Nothing in Visual Basic).

OpcRelativePath(IEnumerable<string>)

Initializes a new instance of the OpcRelativePath class with the pathElements specified to define a path following hierarchical references using the pathElements as the browse names of the nodes their path is to be expressed.

public OpcRelativePath(IEnumerable<string> pathElements)

Public Sub New(pathElements As IEnumerable(Of String))

Parameters

Name	Type	Description
pathElements	IEnumerable<String>	A sequence of string objects representing the value of the BrowseName attribute of the hierarchical nodes their path is to be expressed by the new OpcRelativePath.

Exceptions

Exception	Condition
ArgumentException	One of the items in pathElements is equals to Empty.

OpcRelativePath(params string[])

Initializes a new instance of the OpcRelativePath class with the pathElements specified to define a path following hierarchical references using the pathElements as the browse names of the nodes their path is to be expressed.

public OpcRelativePath(params string[] pathElements)

Public Sub New(ParamArray pathElements As String())

Parameters

Name	Type	Description
pathElements	params String[]	An array of string objects representing the value of the BrowseName attribute of the hierarchical nodes their path is to be expressed by the new OpcRelativePath.

Exceptions

Exception	Condition
ArgumentException	One of the items in pathElements is equals to Empty.

OpcRelativePath(IEnumerable<OpcName>)

Initializes a new instance of the OpcRelativePath class with the pathElements specified to define a path following hierarchical references using the pathElements as the browse names of the nodes their path is to be expressed.

public OpcRelativePath(IEnumerable<OpcName> pathElements)

Public Sub New(pathElements As IEnumerable(Of OpcName))

Parameters

Name	Type	Description
pathElements	IEnumerable<OpcName>	A sequence of OpcName objects representing the value of the BrowseName attribute of the hierarchical nodes their path is to be expressed by the new OpcRelativePath.

Exceptions

Exception	Condition
ArgumentException	One of the items in pathElements does not indicate a name (see IsNull).

OpcRelativePath(params OpcName[])

Initializes a new instance of the OpcRelativePath class with the pathElements specified to define a path following hierarchical references using the pathElements as the browse names of the nodes their path is to be expressed.

public OpcRelativePath(params OpcName[] pathElements)

Public Sub New(ParamArray pathElements As OpcName())

Parameters

Name	Type	Description
pathElements	params OpcName[]	An array of OpcName objects representing the value of the BrowseName attribute of the hierarchical nodes their path is to be expressed by the new OpcRelativePath.

Exceptions

Exception	Condition
ArgumentException	One of the items in pathElements does not indicate a name (see IsNull).

OpcRelativePath(IEnumerable<OpcRelativePathElement>)

Initializes a new instance of the OpcRelativePath class with the pathElements specified.

public OpcRelativePath(IEnumerable<OpcRelativePathElement> pathElements)

Public Sub New(pathElements As IEnumerable(Of OpcRelativePathElement))

Parameters

Name	Type	Description
pathElements	IEnumerable<OpcRelativePathElement>	A sequence of OpcRelativePathElement objects representing the BrowseName and reference of the nodes their path is to be expressed by the new OpcRelativePath.

OpcRelativePath(params OpcRelativePathElement[])

Initializes a new instance of the OpcRelativePath class with the pathElements specified.

public OpcRelativePath(params OpcRelativePathElement[] pathElements)

Public Sub New(ParamArray pathElements As OpcRelativePathElement())

Parameters

Name	Type	Description
pathElements	params OpcRelativePathElement[]	An array of OpcRelativePathElement objects representing the BrowseName and reference of the nodes their path is to be expressed by the new OpcRelativePath.

Properties

Length

Gets the total number of elements in the OpcRelativePath.

public int Length { get; }

Public ReadOnly Property Length As Integer

Property value

Int32

The total number of elements in the OpcRelativePath; zero if there are no elements in the path.

Methods

Combine

static

Combines the paths into a single OpcRelativePath.

public static OpcRelativePath Combine(params OpcRelativePath[] paths)

Public Shared Function Combine(
    ParamArray paths As OpcRelativePath()) As OpcRelativePath

Parameters

Name	Type	Description
paths	params OpcRelativePath[]	An array of parts of the path to construct.

Returns

OpcRelativePath

The combined paths.

Exceptions

Exception	Condition
ArgumentNullException	The paths or one of its items is a null reference (Nothing in Visual Basic).

GetEnumerator

since v2.18

Returns an enumerator that iterates through the path.

public IEnumerator<OpcRelativePathElement> GetEnumerator()

Public Function GetEnumerator() As IEnumerator(Of OpcRelativePathElement)

Returns

IEnumerator<OpcRelativePathElement>

An enumerator that can be used to iterate through the path.

Implements

GetEnumerator()

Parse

static · 2 overloads

Overload	Description
Parse(string)static	Converts a path string to a OpcRelativePath instance.
Parse(OpcContext, string)static · since v2.18	Converts a path string to a OpcRelativePath instance using a specific OpcContext.

Exceptions (all overloads)

Exception	Condition
ArgumentException	The value is an empty string.
ArgumentNullException	The value is a null reference (Nothing in Visual Basic).
FormatException	The value is not a valid path.

Parse(string)

static

Converts a path string to a OpcRelativePath instance.

public static OpcRelativePath Parse(string value)

Public Shared Function Parse(value As String) As OpcRelativePath

Parameters

Name	Type	Description
value	String	A string that contains a path.

Returns

OpcRelativePath

An instance of the OpcRelativePath class.

Parse(OpcContext, string)

static · since v2.18

Converts a path string to a OpcRelativePath instance using a specific OpcContext.

public static OpcRelativePath Parse(OpcContext context, string value)

Public Shared Function Parse(
    context As OpcContext,
    value As String) As OpcRelativePath

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to parse the reference types used in the value.
value	String	A string that contains a path.

Returns

OpcRelativePath

An instance of the OpcRelativePath class.

ToString

2 overloads

Overload	Description
ToString()override	Returns a string representing the relative path.
ToString(OpcContext)since v2.18	Returns a string representing the relative path using the context specified.

ToString()

override

Returns a string representing the relative path.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string formatted using the elements of the current OpcRelativePath.

Overrides

ToString()

ToString(OpcContext)

since v2.18

Returns a string representing the relative path using the context specified.

public string ToString(OpcContext context)

Public Function ToString(context As OpcContext) As String

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to resolve the names of reference types used among the elements in the path.

Returns

String

A string formatted using the elements of the current OpcRelativePath.

Exceptions

Exception	Condition
ArgumentNullException	The context is a null reference (Nothing in Visual Basic).

TryParse

static · 2 overloads · since v2.18

Overload	Description
TryParse(string, out OpcRelativePath)static · since v2.18	Determines whether a string is a valid path.
TryParse(OpcContext, string, out OpcRelativePath)static · since v2.18	Determines whether a string is a valid path using a specific OpcContext.

TryParse(string, out OpcRelativePath)

static · since v2.18

Determines whether a string is a valid path.

public static bool TryParse(string value, out OpcRelativePath path)

Public Shared Function TryParse(
    value As String,
    path As OpcRelativePath) As Boolean

Parameters

Name	Type	Description
value	String	The string to validate.
path	out OpcRelativePath	The OpcRelativePath version of the string.

Returns

Boolean

The value true, if value is a valid path; otherwise the value false.

TryParse(OpcContext, string, out OpcRelativePath)

static · since v2.18

Determines whether a string is a valid path using a specific OpcContext.

public static bool TryParse(
    OpcContext context,
    string value,
    out OpcRelativePath path)

Public Shared Function TryParse(
    context As OpcContext,
    value As String,
    path As OpcRelativePath) As Boolean

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to parse the reference types used in the value.
value	String	The string to validate.
path	out OpcRelativePath	The OpcRelativePath version of the string.

Returns

Boolean

The value true, if value is a valid path; otherwise the value false.

Indexers

Item

Gets the OpcRelativePathElement at the specified index.

public OpcRelativePathElement this[int index] { get; }

Public ReadOnly Default Property this[](
    index As Integer) As OpcRelativePathElement

Parameters

Name	Type	Description
index	Int32	The zero-based index of the element to get.

Property value

OpcRelativePathElement

The OpcRelativePathElement at the specified index.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The index is not a valid index in the OpcRelativePath.