OpcNodeTypeInfo Members

Gets the type from which the current OpcNodeTypeInfo directly inherits.

C#

public virtual OpcNodeTypeInfo BaseType { get; }

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.

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 any semantic information that would help a human to understand what the type represents.

C#

public virtual string Documentation { get; }

Property Value

String

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

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

C#

public static OpcNodeTypeInfo Empty { get; }

Property Value

OpcNodeTypeInfo

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

C#

public virtual bool IsAbstract { get; }

Property Value

Boolean

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

C#

public virtual bool IsEmpty { get; }

Property Value

Boolean

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

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

C#

public virtual bool IsObject { get; }

Property Value

Boolean

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

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

C#

public virtual bool IsSystemType { get; }

Property Value

Boolean

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

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

C#

public virtual bool IsUnknown { get; }

Property Value

Boolean

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

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

C#

public virtual bool IsVariable { get; }

Property Value

Boolean

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

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.

C#

public OpcName Name { get; }

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.

C#

public virtual string SymbolicName { get; }

Property Value

String

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

C#

public OpcNodeId TypeId { get; }

Property Value

OpcNodeId

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

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

C#

public OpcNodeTypeSystem TypeSystem { get; }

Property Value

OpcNodeTypeSystem

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

Gets the type which provides the implementation of the OpcNodeTypeInfo.

C#

public Type UnderlyingType { get; }

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.

C#

public virtual OpcAttributeWriteAccess UserWriteAccess { get; }

Property Value

OpcAttributeWriteAccess

C#

public virtual OpcAttributeWriteAccess WriteAccess { get; }

Property Value

OpcAttributeWriteAccess

Retrieves the value of the attribute specified.

C#

public virtual 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 OpcNodeTypeInfo.

Retrieves the value of the attribute specified.

C#

public 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 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 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(String) (its Value) matches the specified name of the node.

C#

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

C#

public virtual IEnumerable<IOpcNodeInfo> Children()

Returns

IEnumerable<IOpcNodeInfo>

C#

public OpcText Description(string cultureName)

Parameters

cultureName String

Returns

OpcText

C#

public virtual IEnumerable<OpcText> Descriptions()

Returns

IEnumerable<OpcText>

C#

public OpcText DisplayName(string cultureName)

Parameters

cultureName String

Returns

OpcText

C#

public virtual IEnumerable<OpcText> DisplayNames()

Returns

IEnumerable<OpcText>

Searches for the member with the specified name.

C#

public OpcNodeMemberInfo GetMember(string name)

Parameters

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

ArgumentNullException

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

Remarks

The name specified is compared using Ordinal.

Returns all the members of the current OpcNodeTypeInfo.

C#

public OpcNodeMemberInfo[] GetMembers()

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.

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

C#

protected virtual IEnumerable<OpcNodeMemberInfo> GetMembersCore()

Returns

IEnumerable<OpcNodeMemberInfo>

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

Retrieves the Type which provides the implementation of the OpcNodeTypeInfo.

C#

protected virtual Type GetUnderlyingType()

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.

C#

public virtual IEnumerable<OpcReference> References()

Returns

IEnumerable<OpcReference>

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

C#

public override string ToString()

Returns

String

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