Reference

OpcNodeTypeSystem Members

Type

OpcNodeTypeSystem

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Inherits members from OpcTypeSystem<OpcNodeTypeInfo>.

Properties

Context

abstract · since v2.50

Gets the OpcContext used by this OpcNodeTypeSystem.

public abstract OpcContext Context { get; }

Public MustOverride ReadOnly Property Context As OpcContext

Property value

OpcContext

A OpcContext used by this this OpcNodeTypeSystem.

Current

static · since v2.20

Gets the type system used by the Client or Server application.

public static OpcNodeTypeSystem Current { get; }

Public Shared ReadOnly Property Current As OpcNodeTypeSystem

Property value

OpcNodeTypeSystem

An instance of the OpcNodeTypeSystem class which contains the types described by the Types using the OpcDataTypeAttribute implemented in the application which uses the OPC UA SDK.

Default

static · since v2.20

Gets the default type system used by the OPC UA stack.

public static OpcNodeTypeSystem Default { get; }

Public Shared ReadOnly Property [Default] As OpcNodeTypeSystem

Property value

OpcNodeTypeSystem

An instance of the OpcNodeTypeSystem class which contains the types used by default in Client and Server applications.

Remarks

The information offered by the default OpcNodeTypeSystem is embedded in the OPC UA SDK and is therefore determined from the resources of the assembly whenever required.

Empty

static

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

public static OpcNodeTypeSystem Empty { get; }

Public Shared ReadOnly Property Empty As OpcNodeTypeSystem

Property value

OpcNodeTypeSystem

An instance of the OpcNodeTypeSystem class which contains no type information.

HasCachedTypes

protected

Gets a value indicating whether the type system already has determined at least some type information offered as OpcNodeTypeInfo objects.

protected bool HasCachedTypes { get; }

Protected ReadOnly Property HasCachedTypes As Boolean

Property value

Boolean

The value true if the system offers already prepared OpcNodeTypeInfo objects; otherwise the value false.

HasCachingCompleted

protected · virtual

Gets a value indicating whether the type system has determined the whole type information offered as OpcNodeTypeInfo objects.

protected virtual bool HasCachingCompleted { get; }

Protected Overridable Property HasCachingCompleted As Boolean

Property value

Boolean

The value true if the system has completed its type information retrieval and will use its internal cache to determine OpcNodeTypeInfo objects; otherwise the value false.

Methods

GetTypeCore

protected · override · 4 overloads

Overload	Description
GetTypeCore(string)protected · override	Retrieves the OpcNodeTypeInfo object which is known under the name specified.
GetTypeCore(OpcName)protected · override	Retrieves the OpcNodeTypeInfo object which is known under the name specified.
GetTypeCore(OpcNodeId)protected · override	Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.
GetTypeCore(Type)protected · override	Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

GetTypeCore(string)

protected · override

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

protected override OpcNodeTypeInfo GetTypeCore(string name)

Protected Overrides Function GetTypeCore(name As String) As OpcNodeTypeInfo

Parameters

Name	Type	Description
name	String	The string to use to identify the OpcNodeTypeInfo object to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals (regarding its Value) to the name specified; otherwise a null reference (Nothing in Visual Basic).

Overrides

GetTypeCore(string)

Remarks

It is already assured that the passed name is not a null reference (Nothing in Visual Basic) nor equals Empty. In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcNodeTypeInfo objects offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypeCore(OpcName)

protected · override

Retrieves the OpcNodeTypeInfo object which is known under the name specified.

protected override OpcNodeTypeInfo GetTypeCore(OpcName name)

Protected Overrides Function GetTypeCore(name As OpcName) As OpcNodeTypeInfo

Parameters

Name	Type	Description
name	OpcName	The OpcName of the OpcNodeTypeInfo object to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object its Name is equals to the name specified; otherwise a null reference (Nothing in Visual Basic).

Overrides

GetTypeCore(OpcName)

Remarks

It is already assured that the passed name is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcNodeTypeInfo objects offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypeCore(OpcNodeId)

protected · override

Retrieves the OpcNodeTypeInfo object which declares the type which is identified by the typeId specified.

protected override OpcNodeTypeInfo GetTypeCore(OpcNodeId typeId)

Protected Overrides Function GetTypeCore(typeId As OpcNodeId) As OpcNodeTypeInfo

Parameters

Name	Type	Description
typeId	OpcNodeId	The OpcNodeId which identifies the OpcNodeTypeInfo to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which is known under the typeId specified or a null reference (Nothing in Visual Basic) if there doesn't exist a known OpcNodeTypeInfo object which is associated with the typeId specified.

Overrides

GetTypeCore(OpcNodeId)

Remarks

It is already assured that the passed typeId is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcNodeTypeInfo objects offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypeCore(Type)

protected · override

Retrieves the OpcNodeTypeInfo object which declares the type implemented by the underlyingType specified.

protected override OpcNodeTypeInfo GetTypeCore(Type underlyingType)

Protected Overrides Function GetTypeCore(
    underlyingType As Type) As OpcNodeTypeInfo

Parameters

Name	Type	Description
underlyingType	Type	The Type which implements the OpcNodeTypeInfo to retrieve.

Returns

OpcNodeTypeInfo

The OpcNodeTypeInfo object which declares the underlyingType specified or a null reference (Nothing in Visual Basic) if there isn't a OpcNodeTypeInfo object associated with the underlyingType specified.

Overrides

GetTypeCore(Type)

Remarks

It is already assured that the passed underlyingType is not a null reference (Nothing in Visual Basic). In case there this method is not implemented in a derived class this method determines the type from a distinct and on-demand determined sequence which combines the OpcNodeTypeInfo objects offered by RetrieveTypesCore and RetrieveTypesCore. Both methods are called only once and their output is cached for subsequent type information retrieval.

GetTypesCore

protected · override

Retrieves all OpcNodeTypeInfo objects offered by the current OpcNodeTypeSystem .

protected override OpcNodeTypeInfo[] GetTypesCore()

Protected Overrides Function GetTypesCore() As OpcNodeTypeInfo()

Returns

OpcNodeTypeInfo[]

An array that contains all OpcNodeTypeInfo objects that are offered by the OpcNodeTypeSystem.

Overrides

GetTypesCore()

RetrieveTypesCore

protected · 2 overloads

Overload	Description
RetrieveTypesCore()protected	Retrieves all OpcNodeTypeInfo objects explictly offered by the OpcNodeTypeSystem.
RetrieveTypesCore(IDictionary<OpcNodeId, OpcNodeTypeInfo>)protected · virtual	When implemented in a derived class, retrieves all OpcNodeTypeInfo objects on-demand offered by the OpcNodeTypeSystem except the already knownTypes specified.

RetrieveTypesCore()

protected

Retrieves all OpcNodeTypeInfo objects explictly offered by the OpcNodeTypeSystem.

protected IDictionary<OpcNodeId, OpcNodeTypeInfo> RetrieveTypesCore()

Protected Function RetrieveTypesCore() As IDictionary(Of OpcNodeId, OpcNodeTypeInfo)

Returns

IDictionary<OpcNodeId, OpcNodeTypeInfo>

A dictionary of explictly offered OpcNodeTypeInfo objects.

RetrieveTypesCore(IDictionary<OpcNodeId, OpcNodeTypeInfo>)

protected · virtual

When implemented in a derived class, retrieves all OpcNodeTypeInfo objects on-demand offered by the OpcNodeTypeSystem except the already knownTypes specified.

protected virtual IEnumerable<OpcNodeTypeInfo> RetrieveTypesCore(
    IDictionary<OpcNodeId, OpcNodeTypeInfo> knownTypes)

Protected Overridable Function RetrieveTypesCore(
    knownTypes As IDictionary(Of OpcNodeId, OpcNodeTypeInfo)) As IEnumerable(Of OpcNodeTypeInfo)

Parameters

Name	Type	Description
knownTypes	IDictionary<OpcNodeId, OpcNodeTypeInfo>	The dictionary of already known OpcNodeTypeInfo objects which shall not be offered.

Returns

IEnumerable<OpcNodeTypeInfo>

A sequence of OpcNodeTypeInfo objects offered by the OpcNodeTypeSystem except the types in knownTypes.