Reference

IOpcNodeInfo Members

Type

IOpcNodeInfo

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

Category

Gets the NodeCategory attribute which identifies the kind of node and is therefore used to classify the node regarding its use and purpose.

OpcNodeCategory Category { get; }

ReadOnly Property Category As OpcNodeCategory

Property value

OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration.

Description

Gets the value of the optional Description attribute which shall explain the meaning of the node.

OpcText Description { get; }

ReadOnly Property Description As OpcText

Property value

OpcText

A localizable instance of the OpcText class which optionally explains the meaning of the node or a null reference (Nothing in Visual Basic) if there is no description associated with the node.

Remarks

The menaning of the node defines the usage, the context and the purpose of the node.

DisplayName

Gets the value of the DisplayName attribute which defines the localizable name of the node.

OpcText DisplayName { get; }

ReadOnly Property DisplayName As OpcText

Property value

OpcText

An instance of the OpcText class which defines the localizable name of the node.

Remarks

Client application should use this attribute if they want to display the name of the node to the user. The string part of the DisplayName is restricted to 512 characters.

Id

Gets the value of the NodeId attribute which unambiguously identifies the node.

OpcNodeId Id { get; }

ReadOnly Property Id As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId class representing the unambiguously identifier of the node.

Remarks

Some servers may accept alternative node identifiers in addition to the canonical node identifier represented by this attribute.

A server shall persist the node identifier of a node, that is, it shall not generate new node identifiers when rebooting.

Name

Gets the value of the BrowseName attribute which defines the non-localizable human-readable name used when browsing the address space.

OpcName Name { get; }

ReadOnly Property Name As OpcName

Property value

OpcName

Remarks

The Name should never be used to display the name of the a node. Use the DisplayName instead for this purpose.

Unlike node identifiers the Name cannot be used to unambiguously identify the node. Different nodes may have the same browse name. The namespace is provided to make the browse name unique in some cases in the context of a node (e.g. properties of a node) although not unique in the context of the server. If different organizations define browse names for properties, the namespace of the Name provided by the organization makes the Name unique, although different organizations may use the same string having a slightly different meaning. Servers may often choose to use the same namespace for the node identifier and the browse name. However, if they want to provide a standard property, its browse name shall have the namespace of the standards body although the namespace of the node identifier reflects something else, for example the local server.

It is recommended that standard bodies defining standard type definitions use their namespace for the node identifier of the type definition node as well as for the browse name of the type definition node.

The string-part of the browse name is case sensitive. That is, clients shall consider them case sensitive. Server are allowed to handle browse names passed in service requests as case insensitive.

Use the value of this property to construct browse paths (see OpcNamePath).

Parent

Gets the parent node of the node.

IOpcNodeInfo Parent { get; }

ReadOnly Property Parent As IOpcNodeInfo

Property value

IOpcNodeInfo

An instance implementing the IOpcNodeInfo interface which represents the parent node, or a null reference (Nothing in Visual Basic) if no parent node is known.

SymbolicName

Gets a symbolic name for the node which is not expected to be globally unique.

string SymbolicName { get; }

ReadOnly Property SymbolicName As String

Property value

String

The symbolic name of the node, or a null reference (Nothing in Visual Basic) if there is no symbolic name assigned.

Remarks

The symbolic name is not an attribute of the node. A node browsed by a client (see OpcNodeInfo) does not provide a symbolic name.

UserWriteAccess

since v2.50

Gets the value of the optional UserWriteAccess attribute which exposes the possibilities of a client to write the attributes of the node taking user access rights into account.

OpcAttributeWriteAccess UserWriteAccess { get; }

ReadOnly Property UserWriteAccess As OpcAttributeWriteAccess

Property value

OpcAttributeWriteAccess

A combination of the members defined by the OpcAttributeWriteAccess enumeration.

WriteAccess

since v2.50

Gets the value of the optional WriteAccess attribute which exposes the possibilities of a client to write the attributes of the node.

OpcAttributeWriteAccess WriteAccess { get; }

ReadOnly Property WriteAccess As OpcAttributeWriteAccess

Property value

OpcAttributeWriteAccess

A combination of the members defined by the OpcAttributeWriteAccess enumeration.

Methods

AttributeValue

2 overloads · since v2.9

Overload	Description
AttributeValue(OpcAttribute)since v2.9	Retrieves the value of the attribute specified.
AttributeValue<T>(OpcAttribute)since v2.9	Retrieves the value of the attribute specified.

AttributeValue(OpcAttribute)

since v2.9

Retrieves the value of the attribute specified.

object AttributeValue(OpcAttribute attribute)

Function AttributeValue(attribute As OpcAttribute) As Object

Parameters

Name	Type	Description
attribute	OpcAttribute	One of the members defined by the OpcAttribute enumeration which identifies the attribute its value is queried.

Returns

Object

The value of the attribute specified or a null reference (Nothing in Visual Basic) in case there the value of the attribute is a null reference or it is not supported by the current IOpcNodeInfo.

AttributeValue<T>(OpcAttribute)

since v2.9

Retrieves the value of the attribute specified.

T AttributeValue<T>(OpcAttribute attribute)

Function AttributeValue(Of T)(attribute As OpcAttribute) As T

Type parameters

Name	Description
T	The expected type of value the attribute shall offer.

Parameters

Name	Type	Description
attribute	OpcAttribute	One of the members defined by the OpcAttribute enumeration which identifies the attribute its value is queried.

Returns

T

The value of the attribute as the type T specified or the default value of the type T in case there the value of the attribute is a null reference (Nothing in Visual Basic) or it is not supported by the current IOpcNodeInfo.

Child

3 overloads

Overload	Description
Child(string)since v2.27	Retrieves the immutable child node its Name (its Value) or DisplayName (its Value) matches the specified name of the node.
Child(OpcName)since v2.9	Retrieves the immutable child node its Name matches exactly the name specified.
Child(OpcNamePath)since v2.19	Retrieves the immutable child node following the path-of-names using the nodes its Name matches exactly the parts of the namePath specified.

Child(string)

since v2.27

Retrieves the immutable child node its Name (its Value) or DisplayName (its Value) matches the specified name of the node.

IOpcNodeInfo Child(string name)

Function Child(name As String) As IOpcNodeInfo

Parameters

Name	Type	Description
name	String	The nominal information of the child node to retrieve.

Returns

IOpcNodeInfo

An instance implementing the IOpcNodeInfo interface that is known using the specified name; otherwise a null reference (Nothing in Visual Basic) in case there the server does not provide such a child node for the node.

Exceptions

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

Child(OpcName)

since v2.9

Retrieves the immutable child node its Name matches exactly the name specified.

IOpcNodeInfo Child(OpcName name)

Function Child(name As OpcName) As IOpcNodeInfo

Parameters

Name	Type	Description
name	OpcName	The full qualified OpcName of the node to lookup.

Returns

IOpcNodeInfo

An instance implementing the IOpcNodeInfo interface its Name exactly matches the name specified, if such a node is a known child of this node. Otherwise a null reference (Nothing in Visual Basic).

Exceptions

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

Child(OpcNamePath)

since v2.19

Retrieves the immutable child node following the path-of-names using the nodes its Name matches exactly the parts of the namePath specified.

IOpcNodeInfo Child(OpcNamePath namePath)

Function Child(namePath As OpcNamePath) As IOpcNodeInfo

Parameters

Name	Type	Description
namePath	OpcNamePath	The OpcNamePath of full qualified OpcNames of the nodes to follow.

Returns

IOpcNodeInfo

An instance implementing the IOpcNodeInfo interface that has been lookup following the namePath specified, if such a node is a known child of this node (and its children). Otherwise a null reference (Nothing in Basic).

Exceptions

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

Children

since v2.9

Retrieves a sequence of immutable nodes organized as children of this node.

IEnumerable<IOpcNodeInfo> Children()

Function Children() As IEnumerable(Of IOpcNodeInfo)

Returns

IEnumerable<IOpcNodeInfo>

A sequence of instances implementing the IOpcNodeInfo interface which representing the nodes organized as child nodes of this node.

References

since v2.50

Retrieves a sequence of immutable references between this node and other nodes.

IEnumerable<OpcReference> References()

Function References() As IEnumerable(Of OpcReference)

Returns

IEnumerable<OpcReference>

A sequence of OpcReference instances providing hierarchical and non-hierarchical references from this node to other nodes.