Reference

OpcNodeMemberInfo Members

Type

OpcNodeMemberInfo

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

Category

abstract · since v2.50

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

public abstract OpcNodeCategory Category { get; }

Public MustOverride ReadOnly Property Category As OpcNodeCategory

Property value

OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration.

Implements

Category

DeclaringType

Gets the type that declares the current OpcNodeMemberInfo.

public OpcNodeTypeInfo DeclaringType { get; }

Public ReadOnly Property DeclaringType As OpcNodeTypeInfo

Property value

OpcNodeTypeInfo

An instance of the OpcNodeTypeInfo which declares the current OpcNodeMemberInfo.

Description

abstract · since v2.50

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

public abstract OpcText Description { get; }

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

Implements

Description

Remarks

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

DisplayName

abstract · since v2.50

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

public abstract OpcText DisplayName { get; }

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

Documentation

virtual

Gets any semantic information that would help a human to understand what is contained in the member.

public virtual string Documentation { get; }

Public Overridable ReadOnly Property Documentation As String

Property value

String

A human readable text that describes what is contained in the member and that would help a human to understand what the member represented.

Id

abstract · since v2.50

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

public abstract OpcNodeId Id { get; }

Public MustOverride ReadOnly Property Id As OpcNodeId

Property value

OpcNodeId

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

Implements

Id

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.

IsOptional

virtual

Gets a value indicating whether the current member might not necessarily exist in the object defined by the DeclaringType.

public virtual bool IsOptional { get; }

Public Overridable ReadOnly Property IsOptional As Boolean

Property value

Boolean

The value true if the member might not always exists; otherwise the value false.

Implements

IsOptional

MemberType

Gets the type of value this member provides.

public OpcNodeTypeInfo MemberType { get; }

Public ReadOnly Property MemberType As OpcNodeTypeInfo

Property value

OpcNodeTypeInfo

The OpcNodeTypeInfo representing the type of value this member provides.

Name

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

public OpcName Name { get; }

Public ReadOnly Property Name As OpcName

Property value

OpcName

Implements

Name

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

abstract · since v2.50

Gets the node which contains the member.

public abstract IOpcNodeInfo Parent { get; }

Public MustOverride ReadOnly Property Parent As IOpcNodeInfo

Property value

IOpcNodeInfo

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

Exceptions

Exception	Condition
NotSupportedException	The member is declared by a node type defined by a .NET type.

Implements

Parent

ReflectedType

Gets the type that was used to obtain this instance of OpcNodeMemberInfo.

public OpcNodeTypeInfo ReflectedType { get; }

Public ReadOnly Property ReflectedType As OpcNodeTypeInfo

Property value

OpcNodeTypeInfo

An instance of the OpcNodeTypeInfo used to obtain this instance.

Rule

abstract · since v2.50

Gets the modelling rule of the member.

public abstract OpcModellingRule? Rule { get; }

Public MustOverride ReadOnly Property Rule As OpcModellingRule?

Property value

Nullable<OpcModellingRule>

One of the members defined by the OpcModellingRule enumeration, or a null reference (Nothing in Visual Basic) if the member has no modelling rule or it can't be determined.

Exceptions

Exception	Condition
NotSupportedException	The member is declared by a node type defined by a .NET type.

Implements

Rule

SymbolicName

abstract · since v2.50

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

public abstract string SymbolicName { get; }

Public MustOverride ReadOnly Property SymbolicName As String

Property value

String

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

Exceptions

Exception	Condition
NotSupportedException	The member is declared by a node type defined by a .NET type.

Implements

SymbolicName

UserWriteAccess

abstract · since v2.50

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

public abstract OpcAttributeWriteAccess UserWriteAccess { get; }

Public MustOverride ReadOnly Property UserWriteAccess As OpcAttributeWriteAccess

Property value

OpcAttributeWriteAccess

A combination of the members defined by the OpcAttributeWriteAccess enumeration.

Exceptions

Exception	Condition
NotSupportedException	The member is declared by a node type defined by a .NET type.

Implements

UserWriteAccess

WriteAccess

abstract · since v2.50

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

public abstract OpcAttributeWriteAccess WriteAccess { get; }

Public MustOverride ReadOnly Property WriteAccess As OpcAttributeWriteAccess

Property value

OpcAttributeWriteAccess

A combination of the members defined by the OpcAttributeWriteAccess enumeration.

Exceptions

Exception	Condition
NotSupportedException	The member is declared by a node type defined by a .NET type.

Implements

WriteAccess

Methods

AttributeValue

abstract · 2 overloads · since v2.50

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

AttributeValue(OpcAttribute)

abstract · since v2.50

Retrieves the value of the attribute specified.

public abstract object AttributeValue(OpcAttribute attribute)

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

Implements

AttributeValue

AttributeValue<T>(OpcAttribute)

abstract · since v2.50

Retrieves the value of the attribute specified.

public abstract T AttributeValue<T>(OpcAttribute attribute)

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

Implements

AttributeValue

Child

abstract · 3 overloads · since v2.50

Overload	Description
Child(string)abstract · since v2.50	Retrieves the immutable child node its Name (its Value) or DisplayName (its Value) matches the specified name of the node.
Child(OpcName)abstract · since v2.50	Retrieves the immutable child node its Name matches exactly the name specified.
Child(OpcNamePath)abstract · since v2.50	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)

abstract · since v2.50

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

public abstract IOpcNodeInfo Child(string name)

Public MustOverride 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).

Implements

Child

Child(OpcName)

abstract · since v2.50

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

public abstract IOpcNodeInfo Child(OpcName name)

Public MustOverride 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).

Implements

Child

Child(OpcNamePath)

abstract · since v2.50

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

public abstract IOpcNodeInfo Child(OpcNamePath namePath)

Public MustOverride 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).

Implements

Child

Children

abstract · since v2.50

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

public abstract IEnumerable<IOpcNodeInfo> Children()

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

Implements

Children

GetValue

virtual

Gets the value of the member supported by the given object instance.

public virtual object GetValue(object instance)

Public Overridable Function GetValue(instance As Object) As Object

Parameters

Name	Type	Description
instance	Object	The object whose member value will be returned.

Returns

Object

An object containing the value of the member reflected by this instance.

Implements

GetValue

Remarks

This method throws a NotSupportedException and have to be overridden in a derived class.

References

abstract · since v2.50

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

public abstract IEnumerable<OpcReference> References()

Public MustOverride Function References() As IEnumerable(Of OpcReference)

Returns

IEnumerable<OpcReference>

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

Implements

References

SetValue

virtual

Sets the value of the member supported by the given object instance.

public virtual void SetValue(object instance, object value)

Public Overridable Sub SetValue(instance As Object, value As Object)

Parameters

Name	Type	Description
instance	Object	The object whose member value will be set.
value	Object	The value to assign to the member.

Implements

SetValue

Remarks

This method throws a NotSupportedException and have to be overridden in a derived class.

ToString

override

Returns a string representing the Name and MemberType of the current OpcNodeMemberInfo.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string representing the Name and the MemberType of the current OpcNodeMemberInfo.

Overrides

ToString()