Reference

OpcNodeTypeInfo Members

Type

OpcNodeTypeInfo

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

BaseType

virtual

Gets the type from which the current OpcNodeTypeInfo directly inherits.

public virtual OpcNodeTypeInfo BaseType { get; }

Public Overridable ReadOnly Property BaseType As OpcNodeTypeInfo

Property value

OpcNodeTypeInfo

An instance of the OpcNodeTypeInfo which represents the type from which the current OpcNodeTypeInfo directly inherits or a null reference (Nothing in Visual Basic) if the type does not inherit from a different OpcNodeTypeInfo.

Category

abstract

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

Documentation

virtual

Gets any semantic information that would help a human to understand what the type represents.

public virtual string Documentation { get; }

Public Overridable ReadOnly Property Documentation As String

Property value

String

A human readable text that describes the type and that would help a human to understand what the type represents.

Empty

static

Gets the type to use if their is no specific type data available.

public static OpcNodeTypeInfo Empty { get; }

Public Shared ReadOnly Property Empty As OpcNodeTypeInfo

Property value

OpcNodeTypeInfo

An instance of the OpcNodeTypeInfo class which refers to the Empty.

IsAbstract

virtual

Gets a value indicating whether the type is abstract, so that no node can be an instance of it directly.

public virtual bool IsAbstract { get; }

Public Overridable ReadOnly Property IsAbstract As Boolean

Property value

Boolean

The value true if the type is abstract; otherwise the value false.

IsEmpty

virtual

Gets a value indicating whether the current OpcNodeTypeInfo represents a type to use if there is no specific type described.

public virtual bool IsEmpty { get; }

Public Overridable ReadOnly Property IsEmpty As Boolean

Property value

Boolean

The value true if the type does not declare a specific type; otherwise the value false.

IsObject

virtual · since v2.20

Gets a value indicating whether the type is an object node (see Object).

public virtual bool IsObject { get; }

Public Overridable ReadOnly Property IsObject As Boolean

Property value

Boolean

The value true if the current type is an object node; otherwise the value false.

Implements

IsObject

IsSystemType

virtual · since v2.20

Gets a value indicating whether the current IOpcNodeTypeInfo represents one of the predefined built-in node types defined by the OPC UA.

public virtual bool IsSystemType { get; }

Public Overridable ReadOnly Property IsSystemType As Boolean

Property value

Boolean

The value true if the current node type represents a OPC UA is a built-in type; otherwise the value false.

Implements

IsSystemType

IsUnknown

virtual

Gets a value indicating whether the OpcNodeTypeInfo acts as a placeholder for a referenced type its type declaration could not resolved.

public virtual bool IsUnknown { get; }

Public Overridable ReadOnly Property IsUnknown As Boolean

Property value

Boolean

The value true if the OpcNodeTypeInfo acts as a placeholder for an unresolved type declaration; otherwise the value false.

Implements

IsUnknown

IsVariable

virtual · since v2.20

Gets a value indicating whether the type is an object node (see Variable).

public virtual bool IsVariable { get; }

Public Overridable ReadOnly Property IsVariable As Boolean

Property value

Boolean

The value true if the current type is a variable node; otherwise the value false.

Implements

IsVariable

Name

Gets a value which defines the human-readable name of the type represented. A node which represents this OpcNodeTypeInfo uses the Name as its BrowseName.

public OpcName Name { get; }

Public ReadOnly Property Name As OpcName

Property value

OpcName

An instance of the OpcName class with the string used as the name of the type which does not unambiguously identify the OpcNodeTypeInfo.

Implements

Name, Name, Name

SymbolicName

virtual

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

public virtual string SymbolicName { get; }

Public Overridable ReadOnly Property SymbolicName As String

Property value

String

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

Implements

SymbolicName

TypeId

Gets a value which identifies the type represented. A node which represents this OpcNodeTypeInfo uses the TypeId as its NodeId.

public OpcNodeId TypeId { get; }

Public ReadOnly Property TypeId As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId class used as the identifier of the type which unambiguously identifies the OpcNodeTypeInfo.

Implements

TypeId, TypeId

TypeSystem

Gets the the OpcNodeTypeSystem which conains the node type declaration represented.

public OpcNodeTypeSystem TypeSystem { get; }

Public ReadOnly Property TypeSystem As OpcNodeTypeSystem

Property value

OpcNodeTypeSystem

An instance of the OpcNodeTypeSystem class which defines the current OpcNodeTypeInfo.

UnderlyingType

Gets the type which provides the implementation of the OpcNodeTypeInfo.

public Type UnderlyingType { get; }

Public ReadOnly Property UnderlyingType As Type

Property value

Type

The Type which implements the type declared or a null reference (Nothing in Visual Basic) if there does not exist a declaration of the type described by this OpcNodeTypeInfo.

Implements

UnderlyingType, UnderlyingType

UserWriteAccess

virtual

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

public virtual OpcAttributeWriteAccess UserWriteAccess { get; }

Public Overridable ReadOnly Property UserWriteAccess As OpcAttributeWriteAccess

Property value

OpcAttributeWriteAccess

A combination of the members defined by the OpcAttributeWriteAccess enumeration.

Implements

UserWriteAccess

WriteAccess

virtual

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

public virtual OpcAttributeWriteAccess WriteAccess { get; }

Public Overridable ReadOnly Property WriteAccess As OpcAttributeWriteAccess

Property value

OpcAttributeWriteAccess

A combination of the members defined by the OpcAttributeWriteAccess enumeration.

Implements

WriteAccess

Methods

AttributeValue

2 overloads

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

AttributeValue(OpcAttribute)

virtual

Retrieves the value of the attribute specified.

public virtual object AttributeValue(OpcAttribute attribute)

Public Overridable 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 OpcNodeTypeInfo.

Implements

AttributeValue

AttributeValue<T>(OpcAttribute)

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

Implements

AttributeValue

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

public IOpcNodeInfo Child(string name)

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

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

public IOpcNodeInfo Child(OpcName name)

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

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.

public IOpcNodeInfo Child(OpcNamePath namePath)

Public 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

virtual

Retrieves a sequence of all nodes declared as children of the type.

public virtual IEnumerable<IOpcNodeInfo> Children()

Public Overridable Function Children() As IEnumerable(Of IOpcNodeInfo)

Returns

IEnumerable<IOpcNodeInfo>

A sequence of instances implementing the IOpcNodeInfo interface which represent the child nodes of the type, or an empty sequence if the type does not declare any child nodes.

Implements

Children

Description

Retrieves the description of the type in the culture specified.

public OpcText Description(string cultureName)

Public Function Description(cultureName As String) As OpcText

Parameters

Name	Type	Description
cultureName	String	The name of the culture of the description to retrieve.

Returns

OpcText

The first of the Descriptions whose CultureName equals the cultureName ignoring case, or a null reference (Nothing in Visual Basic) if there is none.

Descriptions

virtual

Retrieves the descriptions of the type in all cultures available.

public virtual IEnumerable<OpcText> Descriptions()

Public Overridable Function Descriptions() As IEnumerable(Of OpcText)

Returns

IEnumerable<OpcText>

A sequence of the descriptions of the type, or an empty sequence if there is no description associated with the type.

DisplayName

Retrieves the display name of the type in the culture specified.

public OpcText DisplayName(string cultureName)

Public Function DisplayName(cultureName As String) As OpcText

Parameters

Name	Type	Description
cultureName	String	The name of the culture of the display name to retrieve.

Returns

OpcText

The first of the DisplayNames whose CultureName equals the cultureName ignoring case, or a null reference (Nothing in Visual Basic) if there is none.

DisplayNames

virtual

Retrieves the display names of the type in all cultures available.

public virtual IEnumerable<OpcText> DisplayNames()

Public Overridable Function DisplayNames() As IEnumerable(Of OpcText)

Returns

IEnumerable<OpcText>

A sequence of the display names of the type, or an empty sequence if there is no display name associated with the type.

GetMember

since v2.20

Searches for the member with the specified name.

public OpcNodeMemberInfo GetMember(string name)

Public Function GetMember(name As String) As OpcNodeMemberInfo

Parameters

Name	Type	Description
name	String	The string containing the name of the node member to get.

Returns

OpcNodeMemberInfo

An instance of the OpcNodeMemberInfo representing the member with the specified name, if found; otherwise a null reference (Nothing in Visual Basic).

Exceptions

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

Remarks

The name specified is compared using Ordinal.

GetMembers

since v2.20

Returns all the members of the current OpcNodeTypeInfo.

public OpcNodeMemberInfo[] GetMembers()

Public Function GetMembers() As OpcNodeMemberInfo()

Returns

OpcNodeMemberInfo[]

An array of OpcNodeMemberInfo objects representing all the members defined for the current OpcNodeTypeInfo or an empty array of type OpcNodeMemberInfo if no members are defined for the current OpcNodeTypeInfo.

GetMembersCore

protected · virtual · since v2.20

When overriden in a derived class, searches for the members defined for the current OpcNodeTypeInfo.

protected virtual IEnumerable<OpcNodeMemberInfo> GetMembersCore()

Protected Overridable Function GetMembersCore() As IEnumerable(Of OpcNodeMemberInfo)

Returns

IEnumerable<OpcNodeMemberInfo>

A sequence of OpcNodeMemberInfo objects representing all fields defined for the current OpcNodeTypeInfo.

GetUnderlyingType

protected · virtual

Retrieves the Type which provides the implementation of the OpcNodeTypeInfo.

protected virtual Type GetUnderlyingType()

Protected Overridable Function GetUnderlyingType() As Type

Returns

Type

The Type which implements the type declared or a null reference (Nothing in Visual Basic) if there does not exist a declaration of the type described by this OpcNodeTypeInfo.

References

virtual

Retrieves a sequence of the references between the type and other nodes.

public virtual IEnumerable<OpcReference> References()

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

Returns

IEnumerable<OpcReference>

A sequence of OpcReference instances providing the references from the type to other nodes, or an empty sequence if there are none.

Implements

References, References

ToString

override

Returns a string representing the Name or the UnderlyingType of the current OpcNodeTypeInfo.

public override string ToString()

Public Overrides Function ToString() As String

Returns

String

A string representing the Name or the UnderlyingType of the current OpcNodeTypeInfo.

Overrides

ToString()