Reference

OpcNodeInfo Members

Type

OpcNodeInfo

Namespace

Opc.UaFx.Client

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

Category

Gets the classification of the node using one of the predefined categories.

public OpcNodeCategory Category { get; }

Public ReadOnly Property Category As OpcNodeCategory

Property value

OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration.

Implements

Category

Remarks

Using a category a node can be classified into different top level kinds of nodes like methods, objects, variables and different types.

Context

Gets the browse setup and context to use to inspect the node, its attributes and its relationships to other nodes.

public OpcBrowseNodeContext Context { get; }

Public ReadOnly Property Context As OpcBrowseNodeContext

Property value

OpcBrowseNodeContext

An instance of the OpcBrowseNodeContext class which has been initially created using the configuration specified by the initial browse call using the entry node.

DisplayName

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

public OpcText DisplayName { get; }

Public ReadOnly Property DisplayName As OpcText

Property value

OpcText

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

Implements

DisplayName

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.

Name

Gets the nominal information of the node represented.

public OpcName Name { get; }

Public ReadOnly Property Name As OpcName

Property value

OpcName

An instance of the OpcName class providing the nominal information about the node.

Implements

Name

NodeId

Gets the node identifier of the node represented.

public OpcNodeId NodeId { get; }

Public ReadOnly Property NodeId As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId class providing the (unresolved) node identifier of the node.

Reference

Gets the description of the node reference through that the node represented and examined has been located.

public OpcReferenceDescription Reference { get; }

Public ReadOnly Property Reference As OpcReferenceDescription

Property value

OpcReferenceDescription

An instance of the OpcReferenceDescription class which provides information about the relationship through that the node has been located.

Methods

Attribute

2 overloads

Overload	Description
Attribute(OpcAttribute)	Retrieves the OpcAttributeInfo of the node that has the specified OpcAttribute identifier.
Attribute(string)	Retrieves the OpcAttributeInfo of the node that is known using the specified browseName.

Attribute(OpcAttribute)

Retrieves the OpcAttributeInfo of the node that has the specified OpcAttribute identifier.

public OpcAttributeInfo Attribute(OpcAttribute attribute)

Public Function Attribute(attribute As OpcAttribute) As OpcAttributeInfo

Parameters

Name	Type	Description
attribute	OpcAttribute	The OpcAttribute identifier of the OpcAttributeInfo to retrieve.

Returns

OpcAttributeInfo

An OpcAttributeInfo that has the specified OpcAttribute identifier; otherwise a null reference (Nothing in Visual Basic) in case there the server does not provide such an attribute for the node.

Remarks

Although the server may provide an attribute, the Value (= an OpcValue) or its underlying raw value (Value) can be a null reference (Nothing in Visual Basic). Ensure that the Value may needs to be cast into the attribute dependent type.

The time consumed by the first call of the method depends on the availability of the server, because of the attribute is requested on-demand and is cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

Attribute(string)

Retrieves the OpcAttributeInfo of the node that is known using the specified browseName.

public OpcAttributeInfo Attribute(string browseName)

Public Function Attribute(browseName As String) As OpcAttributeInfo

Parameters

Name	Type	Description
browseName	String	The known browse name of the OpcAttributeInfo to retrieve.

Returns

OpcAttributeInfo

An OpcAttributeInfo that is known using the specified browseName; otherwise a null reference (Nothing in Visual Basic) in case there the server does not provide such an attribute for the node.

Exceptions

Exception	Condition
ArgumentException	The browseName is an empty string.
ArgumentNullException	The browseName is a null reference (Nothing in Visual Basic).

Remarks

Although the server may provide an attribute, the Value (= an OpcValue) or its underlying raw value (Value) can be a null reference (Nothing in Visual Basic). Ensure that the Value may needs to be cast into the attribute dependent type.

The time consumed by the first call of the method depends on the availability of the server, because of the attribute is requested on-demand and is cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

Attributes

5 overloads

Overload	Description
Attributes()	Retrieves for each OpcAttribute identifier the according OpcAttributeInfo of the node.
Attributes(IEnumerable<OpcAttribute>)	Retrieves for each OpcAttribute identifier specified by attributes the according OpcAttributeInfo of the node.
Attributes(params OpcAttribute[])	Retrieves for each OpcAttribute identifier specified by attributes the according OpcAttributeInfo of the node.
Attributes(IEnumerable<string>)	Retrieves the OpcAttributeInfo of the node that is known using the specified browseNames.
Attributes(params string[])	Retrieves the OpcAttributeInfo of the node that is known using the specified browseNames.

Attributes()

Retrieves for each OpcAttribute identifier the according OpcAttributeInfo of the node.

public IEnumerable<OpcAttributeInfo> Attributes()

Public Function Attributes() As IEnumerable(Of OpcAttributeInfo)

Returns

IEnumerable<OpcAttributeInfo>

A sequence of OpcAttributeInfo instances which provides the attribute identifier and attribute value of all in general defined node attributes (see OpcAttribute).

Remarks

Although the server may provide an attribute, the Value (= an OpcValue) or its underlying raw value (Value) can be a null reference (Nothing in Visual Basic). Ensure that the Value may needs to be cast into the attribute dependent type.

The time consumed by the first call of the method depends on the availability of the server, because of the attributes are requested on-demand and are cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

Attributes(IEnumerable<OpcAttribute>)

Retrieves for each OpcAttribute identifier specified by attributes the according OpcAttributeInfo of the node.

public IEnumerable<OpcAttributeInfo> Attributes(
    IEnumerable<OpcAttribute> attributes)

Public Function Attributes(
    attributes As IEnumerable(Of OpcAttribute)) As IEnumerable(Of OpcAttributeInfo)

Parameters

Name	Type	Description
attributes	IEnumerable<OpcAttribute>	A sequence of OpcAttribute identifiers of the OpcAttributeInfo instances to retrieve.

Returns

IEnumerable<OpcAttributeInfo>

A sequence of OpcAttributeInfo instances which provides the attribute identifier and attribute value of the node attributes specified by the OpcAttribute identifiers defined by attributes.

Exceptions

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

Remarks

Although the server may provide an attribute, the Value (= an OpcValue) or its underlying raw value (Value) can be a null reference (Nothing in Visual Basic). Ensure that the Value may needs to be cast into the attribute dependent type.

The time consumed by the first call of the method depends on the availability of the server, because of the attributes are requested on-demand and are cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

Attributes(params OpcAttribute[])

Retrieves for each OpcAttribute identifier specified by attributes the according OpcAttributeInfo of the node.

public IEnumerable<OpcAttributeInfo> Attributes(
    params OpcAttribute[] attributes)

Public Function Attributes(
    ParamArray attributes As OpcAttribute()) As IEnumerable(Of OpcAttributeInfo)

Parameters

Name	Type	Description
attributes	params OpcAttribute[]	An array of OpcAttribute identifiers of the OpcAttributeInfo instances to retrieve.

Returns

IEnumerable<OpcAttributeInfo>

An array of OpcAttributeInfo instances which provides the attribute identifier and attribute value of the node attributes specified by the OpcAttribute identifiers defined by attributes.

Exceptions

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

Remarks

Although the server may provide an attribute, the Value (= an OpcValue) or its underlying raw value (Value) can be a null reference (Nothing in Visual Basic). Ensure that the Value may needs to be cast into the attribute dependent type.

The time consumed by the first call of the method depends on the availability of the server, because of the attributes are requested on-demand and are cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

Attributes(IEnumerable<string>)

Retrieves the OpcAttributeInfo of the node that is known using the specified browseNames.

public IEnumerable<OpcAttributeInfo> Attributes(IEnumerable<string> browseNames)

Public Function Attributes(
    browseNames As IEnumerable(Of String)) As IEnumerable(Of OpcAttributeInfo)

Parameters

Name	Type	Description
browseNames	IEnumerable<String>	A sequence of known browse names of the OpcAttributeInfo to retrieve.

Returns

IEnumerable<OpcAttributeInfo>

A sequence of OpcAttributeInfo instances which provides the attribute identifier and attribute value of the node attributes specified by the browseNames passed.

Exceptions

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

Remarks

Although the server may provide an attribute, the Value (= an OpcValue) or its underlying raw value (Value) can be a null reference (Nothing in Visual Basic). Ensure that the Value may needs to be cast into the attribute dependent type.

The time consumed by the first call of the method depends on the availability of the server, because of the attributes are requested on-demand and are cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

Attributes(params string[])

Retrieves the OpcAttributeInfo of the node that is known using the specified browseNames.

public IEnumerable<OpcAttributeInfo> Attributes(params string[] browseNames)

Public Function Attributes(
    ParamArray browseNames As String()) As IEnumerable(Of OpcAttributeInfo)

Parameters

Name	Type	Description
browseNames	params String[]	An array of known browse names of the OpcAttributeInfo to retrieve.

Returns

IEnumerable<OpcAttributeInfo>

A sequence of OpcAttributeInfo instances which provides the attribute identifier and attribute value of the node attributes specified by the browseNames passed.

Exceptions

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

Remarks

Although the server may provide an attribute, the Value (= an OpcValue) or its underlying raw value (Value) can be a null reference (Nothing in Visual Basic). Ensure that the Value may needs to be cast into the attribute dependent type.

The time consumed by the first call of the method depends on the availability of the server, because of the attributes are requested on-demand and are cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

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.

public object AttributeValue(OpcAttribute attribute)

Public 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 OpcNodeInfo.

Implements

AttributeValue

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the attribute is requested on-demand and is cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

AttributeValue<T>(OpcAttribute)

since v2.9

Retrieves the value of the attribute specified.

public T AttributeValue<T>(OpcAttribute attribute)

Public 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 OpcNodeInfo.

Implements

AttributeValue

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the attribute is requested on-demand and is cached for subsequent calls. This means, that further attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

To improve the performance to query attributes you may consider the configuration of the attributes to prefetch while browsing the nodes using Attributes.

Child

3 overloads

Overload	Description
Child(string)	Retrieves the OpcNodeInfo of the child node that is known using the specified name of the node.
Child(OpcName)since v2.19	Retrieves the OpcNodeInfo its Name matches exactly the name specified.
Child(OpcNamePath)since v2.19	Retrieves the OpcNodeInfo following the path-of-names using the nodes its Name matches exactly the parts of the namePath specified.

Child(string)

Retrieves the OpcNodeInfo of the child node that is known using the specified name of the node.

public OpcNodeInfo Child(string name)

Public Function Child(name As String) As OpcNodeInfo

Parameters

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

Returns

OpcNodeInfo

An OpcNodeInfo 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).

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the child is requested on-demand and is cached for subsequent calls. This means, that further child requests will take use of already retrieved child information and will not demand additional network resources.

Child(OpcName)

since v2.19

Retrieves the OpcNodeInfo its Name matches exactly the name specified.

public OpcNodeInfo Child(OpcName name)

Public Function Child(name As OpcName) As OpcNodeInfo

Parameters

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

Returns

OpcNodeInfo

An OpcNodeInfo that is known using the name specified, if such a node is a known child of this node. Otherwise a null reference (Nothing in Basic).

Exceptions

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

Child(OpcNamePath)

since v2.19

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

public OpcNodeInfo Child(OpcNamePath namePath)

Public Function Child(namePath As OpcNamePath) As OpcNodeInfo

Parameters

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

Returns

OpcNodeInfo

An OpcNodeInfo 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

3 overloads

Overload	Description
Children()	Retrieves for each child node of the node represented the according OpcNodeInfo.
Children(OpcNodeCategory)	Retrieves for each child node of the category specified of the node represented the according OpcNodeInfo.
Children(OpcReferenceType)since v2.8	Retrieves for each child node referenced using the referenceType specified the according OpcNodeInfo.

Children()

Retrieves for each child node of the node represented the according OpcNodeInfo.

public IEnumerable<OpcNodeInfo> Children()

Public Function Children() As IEnumerable(Of OpcNodeInfo)

Returns

IEnumerable<OpcNodeInfo>

A sequence of OpcNodeInfo instances which provides the node information of all nodes referenced as child (see OpcNodeInfo).

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the nodes are requested on-demand and are cached for subsequent calls. This means, that further child requests will take use of already retrieved child information and will not demand additional network resources.

Children(OpcNodeCategory)

Retrieves for each child node of the category specified of the node represented the according OpcNodeInfo.

public IEnumerable<OpcNodeInfo> Children(OpcNodeCategory category)

Public Function Children(
    category As OpcNodeCategory) As IEnumerable(Of OpcNodeInfo)

Parameters

Name	Type	Description
category	OpcNodeCategory	One of the members defined by the OpcNodeCategory enumeration which defines the classification of the child nodes to retrieve or a combination of the members.

Returns

IEnumerable<OpcNodeInfo>

A sequence of OpcNodeInfo instances which provides the node information of all nodes referenced as child of the category specified.

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the nodes are requested on-demand and are cached for subsequent calls. This means, that further child requests will take use of already retrieved child information and will not demand additional network resources.

Children(OpcReferenceType)

since v2.8

Retrieves for each child node referenced using the referenceType specified the according OpcNodeInfo.

public IEnumerable<OpcNodeInfo> Children(OpcReferenceType referenceType)

Public Function Children(
    referenceType As OpcReferenceType) As IEnumerable(Of OpcNodeInfo)

Parameters

Name	Type	Description
referenceType	OpcReferenceType	One of the members defined by the OpcReferenceType enumeration which defines the type of reference between the node represented and child nodes to retrieve.

Returns

IEnumerable<OpcNodeInfo>

A sequence of OpcNodeInfo instances which provides the node information of all nodes referenced as child using the referenceType specified.

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the nodes are requested on-demand and are cached for subsequent calls. This means, that further child requests will take use of already retrieved child information and will not demand additional network resources.

In case there the referenceType specified is not part of the reference types browsed using the Context of the current OpcNodeInfo (see ReferenceTypeIds) there is separate browse operation performed to query the children requested. In this case the child nodes are not cached and are re-queried on every call to this method.

Parent

Retrieves the OpcNodeInfo of the parent node that is known using the specified name of the node.

public OpcNodeInfo Parent(string name)

Public Function Parent(name As String) As OpcNodeInfo

Parameters

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

Returns

OpcNodeInfo

An OpcNodeInfo 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 parent node for the node.

Exceptions

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

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the parent is requested on-demand and is cached for subsequent calls. This means, that further parent requests will take use of already retrieved parent information and will not demand additional network resources.

Parents

3 overloads

Overload	Description
Parents()	Retrieves for each parent node of the node represented the according OpcNodeInfo.
Parents(OpcNodeCategory)	Retrieves for each parent node of the category specified of the node represented the according OpcNodeInfo.
Parents(OpcReferenceType)since v2.8	Retrieves for each parent node referenced using the referenceType specified the according OpcNodeInfo.

Parents()

Retrieves for each parent node of the node represented the according OpcNodeInfo.

public IEnumerable<OpcNodeInfo> Parents()

Public Function Parents() As IEnumerable(Of OpcNodeInfo)

Returns

IEnumerable<OpcNodeInfo>

A sequence of OpcNodeInfo instances which provides the node information of all nodes referenced as parent (see OpcNodeInfo).

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the nodes are requested on-demand and are cached for subsequent calls. This means, that further parent requests will take use of already retrieved parent information and will not demand additional network resources.

Parents(OpcNodeCategory)

Retrieves for each parent node of the category specified of the node represented the according OpcNodeInfo.

public IEnumerable<OpcNodeInfo> Parents(OpcNodeCategory category)

Public Function Parents(
    category As OpcNodeCategory) As IEnumerable(Of OpcNodeInfo)

Parameters

Name	Type	Description
category	OpcNodeCategory	One of the members defined by the OpcNodeCategory enumeration which defines the classification of the parent nodes to retrieve or a combination of the members.

Returns

IEnumerable<OpcNodeInfo>

A sequence of OpcNodeInfo instances which provides the node information of all nodes referenced as parent of the category specified.

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the nodes are requested on-demand and are cached for subsequent calls. This means, that further parent requests will take use of already retrieved parent information and will not demand additional network resources.

Parents(OpcReferenceType)

since v2.8

Retrieves for each parent node referenced using the referenceType specified the according OpcNodeInfo.

public IEnumerable<OpcNodeInfo> Parents(OpcReferenceType referenceType)

Public Function Parents(
    referenceType As OpcReferenceType) As IEnumerable(Of OpcNodeInfo)

Parameters

Name	Type	Description
referenceType	OpcReferenceType	One of the members defined by the OpcReferenceType enumeration which defines the type of reference between the node represented and parent nodes to retrieve.

Returns

IEnumerable<OpcNodeInfo>

A sequence of OpcNodeInfo instances which provides the node information of all nodes referenced as parent using the referenceType specified.

Remarks

The time consumed by the first call of the method depends on the availability of the server, because of the nodes are requested on-demand and are cached for subsequent calls. This means, that further child requests will take use of already retrieved child information and will not demand additional network resources.

In case there the referenceType specified is not part of the reference types browsed using the Context of the current OpcNodeInfo (see ReferenceTypeIds) there is separate browse operation performed to query the parents requested. In this case the parent nodes are not cached and are re-queried on every call to this method.