UANamedNodeDescriptor Class

An OPC UA named node descriptor (a node specified by a named node path and a node name, or by its final node descriptor, or both).

Object Model

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ComVisibleAttribute(False)>
<CLSCompliantAttribute(True)>
<TypeConverterAttribute(System.ComponentModel.ExpandableObjectConverter)>
<ValueControlAttribute("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.80.82.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", 
   DefaultReadWrite=False, 
   Export=True, 
   PageId=10001)>
<SerializableAttribute()>
Public Class UANamedNodeDescriptor 
   Inherits OpcLabs.BaseLib.Info
   Implements LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

'Usage
 
Dim instance As UANamedNodeDescriptor

[ComVisible(false)]
[CLSCompliant(true)]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
[ValueControl("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.80.82.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", 
   DefaultReadWrite=false, 
   Export=true, 
   PageId=10001)]
[Serializable()]
public class UANamedNodeDescriptor : OpcLabs.BaseLib.Info, LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

[ComVisible(false)]
[CLSCompliant(true)]
[TypeConverter(System.ComponentModel.ExpandableObjectConverter)]
[ValueControl("OpcLabs.BaseLib.Forms.Common.ObjectSerializationControl, OpcLabs.BaseLibForms, Version=5.80.82.1, Culture=neutral, PublicKeyToken=6faddca41dacb409", 
   DefaultReadWrite=false, 
   Export=true, 
   PageId=10001)]
[Serializable()]
public ref class UANamedNodeDescriptor : public OpcLabs.BaseLib.Info, LINQPad.ICustomMemberProvider, OpcLabs.BaseLib.ComTypes._Info, OpcLabs.BaseLib.ComTypes._Object2, System.ICloneable, System.Runtime.Serialization.ISerializable, System.Xml.Serialization.IXmlSerializable

Remarks

This object encapsulates an idea of describing a node in the OPC UA address space either by

a named node path (a base node and a list of node names leading from that node forwards), *and* a name of a final node (the final node logically follows after the named node path), or
a node descriptor for the actual, "final" node, specified directly, or
both the parts above.

In your code, you can pick which part you specify, or even specify them both. The receiving code (the method that processes the UANamedNodeDescriptor) then picks the part that is suitable for the task at hand, or it resolves one part into another, if possible and necessary.

For example, when UANamedNodeDescriptor is used to describe a file object in OPC UA File Transfer, the NamedNodePath represents a directory and the NodeName represents the file name. The FinalNodeDescriptor refers directly to the file object node. For some operations, such as opening the file, the FinalNodeDescriptor is sufficient; but alternatively, you can specify the file by using a combination of the directory (NamedNodePath) and the file name (NodeName), and the component will resolve the directory and the file name to the actual file node. In some cases, the NamedNodePath and NodeName are necessary, because the operation requires not just knowing the final node descriptor, but also the node of its parent. This happens, for example, when a file or directory is being moved or deleted.

Inheritance Hierarchy

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

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

UANamedNodeDescriptor Members
OpcLabs.EasyOpc.UA.Navigation Namespace

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.