Reference

OpcRelativePathElement Members

Type

OpcRelativePathElement

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcRelativePathElement

2 overloads

Overload	Description
OpcRelativePathElement(OpcName)	Initializes a new instance of the OpcRelativePathElement class following HierarchicalReferences using the name specified.
OpcRelativePathElement(OpcName, OpcReferenceType)	Initializes a new instance of the OpcRelativePathElement class following the referenceType and name specified.

Exceptions (all overloads)

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

OpcRelativePathElement(OpcName)

Initializes a new instance of the OpcRelativePathElement class following HierarchicalReferences using the name specified.

public OpcRelativePathElement(OpcName name)

Public Sub New(name As OpcName)

Parameters

Name	Type	Description
name	OpcName	The OpcName value of the BrowseName attribute to follow.

OpcRelativePathElement(OpcName, OpcReferenceType)

Initializes a new instance of the OpcRelativePathElement class following the referenceType and name specified.

public OpcRelativePathElement(OpcName name, OpcReferenceType referenceType)

Public Sub New(name As OpcName, referenceType As OpcReferenceType)

Parameters

Name	Type	Description
name	OpcName	The OpcName value of the BrowseName attribute to follow.
referenceType	OpcReferenceType	The OpcReferenceType to follow.

Properties

Direction

since v2.18

Gets a value indicating in which direction the references shall be followed.

public OpcReferenceDirection Direction { get; }

Public ReadOnly Property Direction As OpcReferenceDirection

Property value

OpcReferenceDirection

One of the members defined by the OpcReferenceDirection enumeration.

IncludeSubtypes

since v2.18

Gets a value indicating whether subtypes of the type of reference identified by either ReferenceTypeId or ReferenceTypeName shall be followed as well.

public bool IncludeSubtypes { get; }

Public ReadOnly Property IncludeSubtypes As Boolean

Property value

Boolean

The value true to follow subtypes of the type of reference identified by either ReferenceTypeId or ReferenceTypeName; otherwise the value false.

Name

Gets the BrowseName of the target node to follow.

public OpcName Name { get; }

Public ReadOnly Property Name As OpcName

Property value

OpcName

An instance of the OpcName class or a null reference (Nothing in Visual Basic) if all targets of the references identified by the ReferenceTypeId or ReferenceTypeName shall be followed.

ReferenceType

Gets the according OpcReferenceType value for the ReferenceTypeId to follow.

public OpcReferenceType? ReferenceType { get; }

Public ReadOnly Property ReferenceType As OpcReferenceType?

Property value

Nullable<OpcReferenceType>

One of the members defined by the OpcReferenceType enumeration or a null reference (Nothing in Visual Basic) if the ReferenceTypeId either is a null reference (Nothing in Visual Basic) or refers to a type of reference not represented by the members defined by the OpcReferenceType enumeration.

ReferenceTypeId

Gets the identifier of the rference to follow.

public OpcNodeId ReferenceTypeId { get; }

Public ReadOnly Property ReferenceTypeId As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId class which identifies the type of reference to follow or a null reference (Nothing in Visual Basic) if all references shall be followed.

ReferenceTypeName

since v2.18

Gets the OpcName used to follow a specific type of reference using its BrowseName to determine the according ReferenceTypeId while following the current element.

public OpcName ReferenceTypeName { get; }

Public ReadOnly Property ReferenceTypeName As OpcName

Property value

OpcName

An instance of the OpcName class to resolve the type reference while following the current element or a null reference (Nothing in Visual Basic) if the current element does not define a type of reference to follow (by name).

Methods

ToString

override

Returns a string representing the relative path element.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string formatted using the components of the current OpcRelativePathElement.

Overrides

ToString()