Skip to content

Reference

OpcTypeSystem Members

Defines an abstract implementation of the IOpcTypeSystem to define type information used in different scopes of OPC UA.

Reference

OpcTypeSystem<T> Members ​

Type
OpcTypeSystem<T>
Namespace
Opc.UaFx
Assembly
Opc.UaFx.Advanced.dll
Package
Opc.UaFx.Advanced v2.59.0
Also in
Opc.UaFx.Client

Constructors ​

OpcTypeSystem ​

protected · 2 overloads

OverloadDescription
OpcTypeSystem(OpcTypeSystemScopes)protectedInitializes a new instance of the OpcTypeSystem<T> class using the scope specified without any fallback type system.
OpcTypeSystem(OpcTypeSystemScopes, OpcTypeSystem<T>)protectedInitializes a new instance of the OpcTypeSystem<T> class using the scope and fallbackTypeSystem specified.

OpcTypeSystem(OpcTypeSystemScopes) ​

protected

Initializes a new instance of the OpcTypeSystem<T> class using the scope specified without any fallback type system.

csharp
protected OpcTypeSystem(OpcTypeSystemScopes scope)
vbnet
Protected Sub New(scope As OpcTypeSystemScopes)

Parameters

NameTypeDescription
scopeOpcTypeSystemScopesThe OpcTypeSystemScopes the new type system covers.

OpcTypeSystem(OpcTypeSystemScopes, OpcTypeSystem<T>) ​

protected

Initializes a new instance of the OpcTypeSystem<T> class using the scope and fallbackTypeSystem specified.

csharp
protected OpcTypeSystem(
    OpcTypeSystemScopes scope,
    OpcTypeSystem<T> fallbackTypeSystem)
vbnet
Protected Sub New(
    scope As OpcTypeSystemScopes,
    fallbackTypeSystem As OpcTypeSystem(Of T))

Parameters

NameTypeDescription
scopeOpcTypeSystemScopesThe OpcTypeSystemScopes the new type system covers.
fallbackTypeSystemOpcTypeSystem<T>The type system used as the fallback system to query type information which is referenced in the new OpcTypeSystem<T> but is not declared.

Properties ​

FallbackTypeSystem ​

virtual

Gets the type system used as the fallback system to query type information which is referenced in the current OpcTypeSystem<T> but is not declared.

csharp
public virtual OpcTypeSystem<T> FallbackTypeSystem { get; }
vbnet
Public Overridable ReadOnly Property FallbackTypeSystem As OpcTypeSystem(Of T)

Property value

OpcTypeSystem<T>

An instance of the OpcTypeSystem<T> class used to query type information which is referenced but not declared within the current OpcTypeSystem<T> or a null reference (Nothing in Visual Basic) if the current OpcTypeSystem<T> is independent from a different type system. Such type systems typically declare types which only reference others declared in the same system as well.

IsEmpty ​

virtual

Gets a value indicating whether the current OpcTypeSystem<T> represents a type system to use if there is no specific type system described.

csharp
public virtual bool IsEmpty { get; }
vbnet
Public Overridable ReadOnly Property IsEmpty As Boolean

Property value

Boolean

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

Implements

IsEmpty

Scope ​

Gets the scope of types covered by the current OpcTypeSystem<T>.

csharp
public OpcTypeSystemScopes Scope { get; }
vbnet
Public ReadOnly Property Scope As OpcTypeSystemScopes

Property value

OpcTypeSystemScopes

One of the members defined by the OpcTypeSystemScopes enumeration.

Implements

Scope

Methods ​

GetType ​

4 overloads

OverloadDescription
GetType(string)Retrieves the T object which is known under the name specified.
GetType(OpcName)Retrieves the T object which is known under the name specified.
GetType(OpcNodeId)Retrieves the T object which declares the type which is identified by the typeId specified.
GetType(Type)Retrieves the T object which declares the type implemented by the underlyingType specified.

GetType(string) ​

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

csharp
public T GetType(string name)
vbnet
Public Function [GetType](name As String) As T

Parameters

NameTypeDescription
nameStringThe string to use to identify the T object to retrieve.

Returns

T

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

Exceptions

ExceptionCondition
ArgumentExceptionThe name is equals Empty.
ArgumentNullExceptionThe name is a null reference (Nothing in Visual Basic).

GetType(OpcName) ​

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

csharp
public T GetType(OpcName name)
vbnet
Public Function [GetType](name As OpcName) As T

Parameters

NameTypeDescription
nameOpcNameThe OpcName of the T object to retrieve.

Returns

T

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

Exceptions

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

GetType(OpcNodeId) ​

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

csharp
public T GetType(OpcNodeId typeId)
vbnet
Public Function [GetType](typeId As OpcNodeId) As T

Parameters

NameTypeDescription
typeIdOpcNodeIdThe OpcNodeId which identifies the T to retrieve.

Returns

T

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

Exceptions

ExceptionCondition
ArgumentNullExceptionThe typeId is a null reference (Nothing in Visual Basic).

GetType(Type) ​

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

csharp
public T GetType(Type underlyingType)
vbnet
Public Function [GetType](underlyingType As Type) As T

Parameters

NameTypeDescription
underlyingTypeTypeThe Type which implements the T to retrieve.

Returns

T

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

Exceptions

ExceptionCondition
ArgumentNullExceptionThe underlyingType is a null reference (Nothing in Visual Basic).

GetTypeCore ​

protected · abstract · 4 overloads

OverloadDescription
GetTypeCore(string)protected · abstractRetrieves the T object which is known under the name specified.
GetTypeCore(OpcName)protected · abstractRetrieves the T object which is known under the name specified.
GetTypeCore(OpcNodeId)protected · abstractRetrieves the T object which declares the type which is identified by the typeId specified.
GetTypeCore(Type)protected · abstractRetrieves the T object which declares the type implemented by the underlyingType specified.

GetTypeCore(string) ​

protected · abstract

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

csharp
protected abstract T GetTypeCore(string name)
vbnet
Protected MustOverride Function GetTypeCore(name As String) As T

Parameters

NameTypeDescription
nameStringThe string to use to identify the T object to retrieve.

Returns

T

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

Remarks

It is already assured that the passed name is not a null reference (Nothing in Visual Basic) nor equals Empty.

GetTypeCore(OpcName) ​

protected · abstract

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

csharp
protected abstract T GetTypeCore(OpcName name)
vbnet
Protected MustOverride Function GetTypeCore(name As OpcName) As T

Parameters

NameTypeDescription
nameOpcNameThe OpcName of the T object to retrieve.

Returns

T

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

Remarks

It is already assured that the passed name is not a null reference (Nothing in Visual Basic).

GetTypeCore(OpcNodeId) ​

protected · abstract

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

csharp
protected abstract T GetTypeCore(OpcNodeId typeId)
vbnet
Protected MustOverride Function GetTypeCore(typeId As OpcNodeId) As T

Parameters

NameTypeDescription
typeIdOpcNodeIdThe OpcNodeId which identifies the T to retrieve.

Returns

T

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

Remarks

It is already assured that the passed typeId is not a null reference (Nothing in Visual Basic).

GetTypeCore(Type) ​

protected · abstract

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

csharp
protected abstract T GetTypeCore(Type underlyingType)
vbnet
Protected MustOverride Function GetTypeCore(underlyingType As Type) As T

Parameters

NameTypeDescription
underlyingTypeTypeThe Type which implements the T to retrieve.

Returns

T

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

Remarks

It is already assured that the passed underlyingType is not a null reference (Nothing in Visual Basic).

GetTypes ​

Retrieves all T objects offered by the OpcTypeSystem<T>.

csharp
public T[] GetTypes()
vbnet
Public Function GetTypes() As T()

Returns

T[]

An array that contains all T objects that are offered by the OpcTypeSystem<T>.

GetTypesCore ​

protected · abstract

Retrieves all T objects offered by the current OpcTypeSystem<T> .

csharp
protected abstract T[] GetTypesCore()
vbnet
Protected MustOverride Function GetTypesCore() As T()

Returns

T[]

An array that contains all T objects that are offered by the OpcTypeSystem<T>.