UABrowsePathElement Class

Represents an element in the OPC-UA browse path.

Object Model

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CLSCompliantAttribute(True)>
<ComDefaultInterfaceAttribute(OpcLabs.EasyOpc.UA.Navigation.ComTypes._UABrowsePathElement)>
<ComVisibleAttribute(True)>
<GuidAttribute("3CE3E988-805D-42AF-AC15-974D93E91240")>
<TypeConverterAttribute(OpcLabs.EasyOpc.UA.Navigation.Implementation.UABrowsePathElementConverter)>
<ValueControlAttribute("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.72.465.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", 
   DefaultReadWrite=False, 
   Export=True, 
   PageId=10001)>
<SerializableAttribute()>
Public NotInheritable Class UABrowsePathElement 
   Inherits OpcLabs.BaseLib.Info
   Implements LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.EasyOpc.UA.Navigation.ComTypes._UABrowsePathElement, IUABrowsePathElement, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

'Usage
 
Dim instance As UABrowsePathElement

[CLSCompliant(true)]
[ComDefaultInterface(OpcLabs.EasyOpc.UA.Navigation.ComTypes._UABrowsePathElement)]
[ComVisible(true)]
[Guid("3CE3E988-805D-42AF-AC15-974D93E91240")]
[TypeConverter(OpcLabs.EasyOpc.UA.Navigation.Implementation.UABrowsePathElementConverter)]
[ValueControl("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.72.465.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", 
   DefaultReadWrite=false, 
   Export=true, 
   PageId=10001)]
[Serializable()]
public sealed class UABrowsePathElement : OpcLabs.BaseLib.Info, LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.EasyOpc.UA.Navigation.ComTypes._UABrowsePathElement, IUABrowsePathElement, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

[CLSCompliant(true)]
[ComDefaultInterface(OpcLabs.EasyOpc.UA.Navigation.ComTypes._UABrowsePathElement)]
[ComVisible(true)]
[Guid("3CE3E988-805D-42AF-AC15-974D93E91240")]
[TypeConverter(OpcLabs.EasyOpc.UA.Navigation.Implementation.UABrowsePathElementConverter)]
[ValueControl("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.72.465.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", 
   DefaultReadWrite=false, 
   Export=true, 
   PageId=10001)]
[Serializable()]
public ref class UABrowsePathElement sealed : public OpcLabs.BaseLib.Info, LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, OpcLabs.EasyOpc.UA.Navigation.ComTypes._UABrowsePathElement, IUABrowsePathElement, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

Remarks

OPC UA browse path elements are represented by UABrowsePathElement objects. Each browse path element has following data members:

ReferenceTypeId Property. The type of reference (an instance of UANodeId Class) to follow from the current node. The current path cannot be followed any further if the reference type is not available on the node instance.
ReferenceIsInverse Property. Indicates whether the inverse Reference should be followed.
IncludeSubtypes Property. Indicates whether subtypes of the ReferenceType should be followed.
TargetName Property. The browse name of the target node (an instance of UAQualifiedName Class).

The UABrowsePathElement has various constructor overloads with different combinations of these parameters. In addition, there are static methods on the UABrowsePathElement Class that allow you to easily create commonly used browse path elements:

The Create Method creates a new OPC-UA browse path element with given reference type and target name, for following in forward direction, and including subtypes.
The CreateInverse Method creates a new OPC-UA browse path element with given reference type and target name, for following in inverse direction, and including subtypes.
The CreateSimple Method creates a new OPC-UA browse path element with given target name, and specifying any hierarchical forward reference.
There are static methods for creation of browse path elements for all standard *concrete* references, taking just the target name as input. For example, the HasProperty Method creates a browse path element for following a specific HasProperty reference in a forward direction.

The created browse path elements can then be added to a UABrowsePathElementCollection Class, forming a relative path.

Inheritance Hierarchy

System.Object
   OpcLabs.BaseLib.Object2
      OpcLabs.BaseLib.Info
         OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UABrowsePathElement Members
OpcLabs.EasyOpc.UA.Navigation Namespace

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.