OpcNodeMemberInfo Members

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

C#

public abstract OpcNodeCategory Category { get; }

Property Value

OpcNodeCategory

One of the members defined by the OpcNodeCategory enumeration.

Gets the type that declares the current OpcNodeMemberInfo.

C#

public OpcNodeTypeInfo DeclaringType { get; }

Property Value

OpcNodeTypeInfo

An instance of the OpcNodeTypeInfo which declares the current OpcNodeMemberInfo.

Gets the value of the optional DescriptionOpcAttribute which shall explain the meaning of the node.

C#

public abstract OpcText Description { get; }

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.

Gets the value of the DisplayNameOpcAttribute which defines the localizable name of the node.

C#

public abstract OpcText DisplayName { get; }

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.

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

C#

public virtual string Documentation { get; }

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.

Gets the value of the NodeIdOpcAttribute which unambiguously identifies the node.

C#

public abstract OpcNodeId Id { get; }

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.

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

C#

public virtual bool IsOptional { get; }

Property Value

Boolean

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

Gets the type of value this member provides.

C#

public OpcNodeTypeInfo MemberType { get; }

Property Value

OpcNodeTypeInfo

The OpcNodeTypeInfo representing the type of value this member provides.

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

C#

public OpcName Name { get; }

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

C#

public abstract IOpcNodeInfo Parent { get; }

Property Value

IOpcNodeInfo

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

C#

public OpcNodeTypeInfo ReflectedType { get; }

Property Value

OpcNodeTypeInfo

An instance of the OpcNodeTypeInfo used to obtain this instance.

C#

public abstract OpcModellingRule? Rule { get; }

Property Value

Nullable<OpcModellingRule>

C#

public abstract string SymbolicName { get; }

Property Value

String

C#

public abstract OpcAttributeWriteAccess UserWriteAccess { get; }

Property Value

OpcAttributeWriteAccess

C#

public abstract OpcAttributeWriteAccess WriteAccess { get; }

Property Value

OpcAttributeWriteAccess

Retrieves the value of the attribute specified.

C#

public abstract object AttributeValue(OpcAttribute attribute)

Parameters

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.

Retrieves the value of the attribute specified.

C#

public abstract T AttributeValue<T>(OpcAttribute attribute)

Parameters

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.

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

C#

public abstract IOpcNodeInfo Child(OpcName name)

Parameters

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

ArgumentNullException

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

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

C#

public abstract IOpcNodeInfo Child(OpcNamePath namePath)

Parameters

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

ArgumentNullException

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

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

C#

public abstract IOpcNodeInfo Child(string name)

Parameters

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

ArgumentNullException

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

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

C#

public abstract IEnumerable<IOpcNodeInfo> Children()

Returns

IEnumerable<IOpcNodeInfo>

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

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

C#

public virtual object GetValue(object instance)

Parameters

instance Object

The Object whose member value will be returned.

Returns

Object

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

Remarks

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

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

C#

public abstract IEnumerable<OpcReference> References()

Returns

IEnumerable<OpcReference>

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

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

C#

public virtual void SetValue(object instance, object value)

Parameters

instance Object

The Object whose member value will be set.

value Object

The value to assign to the member.

Remarks

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

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

C#

public override string ToString()

Returns

String

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