Reference

OpcData Members

Type

OpcData

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Constructors

OpcData

protected · 2 overloads

Overload	Description
OpcData()protected · since v2.32	Initializes a new instance of the OpcData class.
OpcData(IOpcDataStore)protected	Initializes a new instance of the OpcData class using the dataStore specified.

OpcData()

protected · since v2.32

Initializes a new instance of the OpcData class.

protected OpcData()

Protected Sub New()

OpcData(IOpcDataStore)

protected

Initializes a new instance of the OpcData class using the dataStore specified.

protected OpcData(IOpcDataStore dataStore)

Protected Sub New(dataStore As IOpcDataStore)

Parameters

Name	Type	Description
dataStore	IOpcDataStore	The IOpcDataStore of the object data to represent.

Exceptions

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

Properties

DataStore

protected

Gets the IOpcDataStore which contains the data of this OpcData instance.

protected IOpcDataStore DataStore { get; }

Protected ReadOnly Property DataStore As IOpcDataStore

Property value

IOpcDataStore

An instance implementing the IOpcDataStore interface containing the object data represented by this OpcData instance.

Methods

Decode

static · 3 overloads

Overload	Description
Decode<T>(OpcContext, byte[])static · since v2.40	Converts the buffer specified to the T defined.
Decode<T>(OpcContext, Stream)static · since v2.40	Converts the data in the stream specified to the T defined.
Decode<T>(OpcContext, OpcRawObject)static · since v2.58	Converts the value specified to the T defined.

Exceptions (all overloads)

Exception	Condition
OpcException	The decoding has failed. For more details exception data.

Decode<T>(OpcContext, byte[])

static · since v2.40

Converts the buffer specified to the T defined.

public static T Decode<T>(OpcContext context, byte[] buffer) where T : new()

Public Shared Function Decode(Of T As New)(
    context As OpcContext,
    buffer As Byte()) As T

Type parameters

Name	Description
T	The type to decode with a default constructor.

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to decode the buffer.
buffer	Byte[]	An array of byte values to decode.

Returns

T

A new instance of the type defined by T and decoded with the information in the buffer.

Exceptions

Exception	Condition
ArgumentNullException	The context or buffer is a null reference (Nothing in Visual Basic).

Decode<T>(OpcContext, Stream)

static · since v2.40

Converts the data in the stream specified to the T defined.

public static T Decode<T>(OpcContext context, Stream stream) where T : new()

Public Shared Function Decode(Of T As New)(
    context As OpcContext,
    stream As Stream) As T

Type parameters

Name	Description
T	The type to decode with a default constructor.

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to decode the stream data.
stream	Stream	A Stream its data is to be decoded.

Returns

T

A new instance of the type defined by T and decoded with the information in the stream.

Exceptions

Exception	Condition
ArgumentNullException	The context or stream is a null reference (Nothing in Visual Basic).

Decode<T>(OpcContext, OpcRawObject)

static · since v2.58

Converts the value specified to the T defined.

public static T Decode<T>(
    OpcContext context,
    OpcRawObject value)
    where T : new()

Public Shared Function Decode(Of T As New)(
    context As OpcContext,
    value As OpcRawObject) As T

Type parameters

Name	Description
T	The type to decode with a default constructor.

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to decode the value.
value	OpcRawObject	The OpcRawObject to decode, either binary or XML encoded.

Returns

T

A new instance of the type defined by T and decoded with the information in the RawData of the value.

Exceptions

Exception	Condition
ArgumentNullException	The context or value is a null reference (Nothing in Visual Basic).

DeepCopy

protected · virtual

Creates a copy of the current OpcData, which the SDK uses whenever it copies an encodable value of it.

protected virtual object DeepCopy()

Protected Overridable Function DeepCopy() As Object

Returns

Object

A new object which is a copy of the current OpcData.

Remarks

The default implementation creates a shallow copy (see MemberwiseClone()). Override it to copy referenced objects too.

Encode

static · 2 overloads · since v2.58

Overload	Description
Encode(OpcContext, object)static · since v2.58	Encodes the value specified using its Binary encoding.
Encode(OpcContext, object, OpcEncodingType)static · since v2.58	Encodes the value specified using its encoding of the encodingType specified.

Exceptions (all overloads)

Exception	Condition
ArgumentNullException	The context or value is a null reference (Nothing in Visual Basic).
OpcException	The encoding has failed.

Encode(OpcContext, object)

static · since v2.58

Encodes the value specified using its Binary encoding.

public static OpcRawObject Encode(OpcContext context, object value)

Public Shared Function Encode(
    context As OpcContext,
    value As Object) As OpcRawObject

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to encode the value.
value	Object	The value of a structured data type to encode.

Returns

OpcRawObject

A new instance of the OpcRawObject class with the encoded value.

Exceptions

Exception	Condition
ArgumentException	The value is not the value of a structured data type or its data type does not state a binary encoding.

Encode(OpcContext, object, OpcEncodingType)

static · since v2.58

Encodes the value specified using its encoding of the encodingType specified.

public static OpcRawObject Encode(
    OpcContext context,
    object value,
    OpcEncodingType encodingType)

Public Shared Function Encode(
    context As OpcContext,
    value As Object,
    encodingType As OpcEncodingType) As OpcRawObject

Parameters

Name	Type	Description
context	OpcContext	The OpcContext to use to encode the value.
value	Object	The value of a structured data type to encode.
encodingType	OpcEncodingType	One of the members defined by the OpcEncodingType enumeration which states the encoding to use.

Returns

OpcRawObject

A new instance of the OpcRawObject class with the encoded value.

Exceptions

Exception	Condition
ArgumentException	The value is not the value of a structured data type or its data type does not state an encoding of the encodingType.

GetDataStore

protected · virtual · since v2.32

Retrieves the IOpcDataStore which contains the data of this OpcData instance.

protected virtual IOpcDataStore GetDataStore()

Protected Overridable Function GetDataStore() As IOpcDataStore

Returns

IOpcDataStore

The IOpcDataStore which contains the data of this OpcData instance. The default implementation returns the data store passed to the constructor.

Remarks

The DataStore property calls this method once, on its first access, if no data store was passed to the constructor. Override it to provide the data store on demand.

GetType

static

Retrieves the Type which implementes the data type which is identified by the typeId specified.

public static Type GetType(OpcNodeId typeId)

Public Shared Function [GetType](typeId As OpcNodeId) As Type

Parameters

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

Returns

Type

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

Exceptions

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

GetTypeInfo

static · 4 overloads

Overload	Description
GetTypeInfo<T>()static	Retrieves the OpcDataTypeInfo which declares the data type implemented by the T specified.
GetTypeInfo(OpcEncoding)static	Retrieves the OpcDataTypeInfo which declares the data type which is identified by the encoding specified.
GetTypeInfo(OpcNodeId)static	Retrieves the OpcDataTypeInfo which declares the data type which is identified by the typeId specified.
GetTypeInfo(Type)static	Retrieves the OpcDataTypeInfo which declares the data type implemented by the underlyingType specified.

GetTypeInfo<T>()

static

Retrieves the OpcDataTypeInfo which declares the data type implemented by the T specified.

public static OpcDataTypeInfo GetTypeInfo<T>()

Public Shared Function GetTypeInfo(Of T)() As OpcDataTypeInfo

Type parameters

Name	Description
T	The Type which implements the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

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

GetTypeInfo(OpcEncoding)

static

Retrieves the OpcDataTypeInfo which declares the data type which is identified by the encoding specified.

public static OpcDataTypeInfo GetTypeInfo(OpcEncoding encoding)

Public Shared Function GetTypeInfo(encoding As OpcEncoding) As OpcDataTypeInfo

Parameters

Name	Type	Description
encoding	OpcEncoding	The OpcEncoding which identifies the OpcDataTypeInfo to retrieve.

Returns

OpcDataTypeInfo

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

Exceptions

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

GetTypeInfo(OpcNodeId)

static

Retrieves the OpcDataTypeInfo which declares the data type which is identified by the typeId specified.

public static OpcDataTypeInfo GetTypeInfo(OpcNodeId typeId)

Public Shared Function GetTypeInfo(typeId As OpcNodeId) As OpcDataTypeInfo

Parameters

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

Returns

OpcDataTypeInfo

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

Exceptions

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

GetTypeInfo(Type)

static

Retrieves the OpcDataTypeInfo which declares the data type implemented by the underlyingType specified.

public static OpcDataTypeInfo GetTypeInfo(Type underlyingType)

Public Shared Function GetTypeInfo(underlyingType As Type) As OpcDataTypeInfo

Parameters

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

Returns

OpcDataTypeInfo

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

Exceptions

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

New

static

Creates a new instance of the OpcDataObject class using the dataType specified.

public static OpcDataObject New(OpcDataTypeInfo dataType)

Public Shared Function [New](dataType As OpcDataTypeInfo) As OpcDataObject

Parameters

Name	Type	Description
dataType	OpcDataTypeInfo	The OpcDataTypeInfo which declares the type of data type instance the new OpcDataObject shall represent.

Returns

OpcDataObject

An instance of the OpcDataObject which can be used to dynamically access data type instance information.

Exceptions

Exception	Condition
ArgumentException	The dataType is not a structured data type (see IsStruct).
ArgumentNullException	The dataType is a null reference (Nothing in Visual Basic).

NewArray

static

Creates a one-dimensional array of OpcDataObject objects using the dataType and length with zero-based indexing.

public static OpcDataObject[] NewArray(OpcDataTypeInfo dataType, int length)

Public Shared Function NewArray(
    dataType As OpcDataTypeInfo,
    length As Integer) As OpcDataObject()

Parameters

Name	Type	Description
dataType	OpcDataTypeInfo	The OpcDataTypeInfo which declares the type of data type instance the new OpcDataObject shall represent.
length	Int32	An size of the array to create.

Returns

OpcDataObject[]

A new one-dimensional array of OpcDataObject instances which can be used to dynamically access array-based data type information

Exceptions

Exception	Condition
ArgumentException	The dataType is not a structured data type (see IsStruct).
ArgumentNullException	The dataType is a null reference (Nothing in Visual Basic).

RegisterType

static · 6 overloads

Overload	Description
RegisterType<T>()static	Registers the type defined by T as the data object type to create in case there a data instance is to be created for the type definition identified by the OpcDataTypeAttribute defined on the T specified.
RegisterType(Type)static · since v2.14	Registers the dataType specified as the data object type to create in case there a data instance is to be created for the type definition identified by the OpcDataTypeAttribute defined on the dataType specified.
RegisterType<T>(OpcNodeId)static	Registers the type defined by T as the data object type to create in case there a data instance is to be created for the type definition identified by the dataTypeId specified.
RegisterType(Type, OpcNodeId)static · since v2.14	Registers the dataType specified as the data object type to create in case there a data instance is to be created for the type definition identified by the dataTypeId specified.
RegisterType<T>(OpcNodeId, params OpcEncoding[])static	Registers the type defined by T as the data object type to create in case there a data instance is to be created for the type definition identified by the dataTypeId or by one of the dataTypeEncodings specified.
RegisterType(Type, OpcNodeId, params OpcEncoding[])static · since v2.14	Registers the dataType specified as the data object type to create in case there a data instance is to be created for the type definition identified by the dataTypeId or by one of the dataTypeEncodings specified.

RegisterType<T>()

static

Registers the type defined by T as the data object type to create in case there a data instance is to be created for the type definition identified by the OpcDataTypeAttribute defined on the T specified.

public static void RegisterType<T>()

Public Shared Sub RegisterType(Of T)()

Type parameters

Name	Description
T	The type to use in case there a data object for the data definition equals to the data type identifier defined using the OpcDataTypeAttribute is to be created. The type needs to provide either a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface and then needs to be a subclass of the OpcData class.

Exceptions

Exception	Condition
ArgumentException	The type T does not define a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface or any data type specific attribute offers invalid information about the data type to associate with the Type.

RegisterType(Type)

static · since v2.14

Registers the dataType specified as the data object type to create in case there a data instance is to be created for the type definition identified by the OpcDataTypeAttribute defined on the dataType specified.

public static void RegisterType(Type dataType)

Public Shared Sub RegisterType(dataType As Type)

Parameters

Name	Type	Description
dataType	Type	The Type to use in case there a data object for the data type definition equals to the data type identifier defined using the OpcDataTypeAttribute is to be created. The type needs to provide either a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface and then needs to be a subclass of the OpcData class.

Exceptions

Exception	Condition
ArgumentException	The dataType does not define a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface or any data type specific attribute offers invalid information about the data type to associate with the Type.
ArgumentNullException	The dataType is a null reference (Nothing in Visual Basic).

RegisterType<T>(OpcNodeId)

static

Registers the type defined by T as the data object type to create in case there a data instance is to be created for the type definition identified by the dataTypeId specified.

public static void RegisterType<T>(OpcNodeId dataTypeId)

Public Shared Sub RegisterType(Of T)(dataTypeId As OpcNodeId)

Type parameters

Name	Description
T	The type to use in case there a data object for the data definition equals to dataTypeId is to be created. The type needs to provide either a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface and then needs to be a subclass of the OpcData class.

Parameters

Name	Type	Description
dataTypeId	OpcNodeId	The identifier of the type definition for which the T is to be used to create a data object instance.

Exceptions

Exception	Condition
ArgumentException	The type T does not define a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface or any data type specific attribute offers invalid information about the data type to associate with the Type.
ArgumentNullException	The dataTypeId is a null reference (Nothing in Visual Basic).

Remarks

It is not possible to register the same or a different data type for the dataTypeId specified as long there is already a data type registered for the type definition specified by dataTypeId.

RegisterType(Type, OpcNodeId)

static · since v2.14

Registers the dataType specified as the data object type to create in case there a data instance is to be created for the type definition identified by the dataTypeId specified.

public static void RegisterType(Type dataType, OpcNodeId dataTypeId)

Public Shared Sub RegisterType(dataType As Type, dataTypeId As OpcNodeId)

Parameters

Name	Type	Description
dataType	Type	The Type to use in case there a data object for the data type definition equals to dataTypeId is to be created. The type needs to provide either a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface and then needs to be a subclass of the OpcData class.
dataTypeId	OpcNodeId	The identifier of the type definition for which the dataType is to be used to create a data object instance.

Exceptions

Exception	Condition
ArgumentException	The dataType does not define a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface or any data type specific attribute offers invalid information about the data type to associate with the Type.
ArgumentNullException	The dataType or dataTypeId is a null reference (Nothing in Visual Basic).

Remarks

It is not possible to register the same or a different data type for the dataTypeId specified as long there is already a data type registered for the type definition specified by dataTypeId.

RegisterType<T>(OpcNodeId, params OpcEncoding[])

static

Registers the type defined by T as the data object type to create in case there a data instance is to be created for the type definition identified by the dataTypeId or by one of the dataTypeEncodings specified.

public static void RegisterType<T>(
    OpcNodeId dataTypeId,
    params OpcEncoding[] dataTypeEncodings)

Public Shared Sub RegisterType(Of T)(
    dataTypeId As OpcNodeId,
    ParamArray dataTypeEncodings As OpcEncoding())

Type parameters

Name	Description
T	The type to use in case there a data object for the data definition equals to dataTypeId or equals to one of the dataTypeEncodings specified is to be created. The type needs to provide either a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface and then needs to be a subclass of the OpcData class.

Parameters

Name	Type	Description
dataTypeId	OpcNodeId	The identifier of the type definition for which the T is to be used to create a data object instance.
dataTypeEncodings	params OpcEncoding[]	An array of OpcEncoding instances identifying the different encodings supported by the T specified. Using OpcEncoding instances enables the possibility to define OpcEncodingType specific identifiers to use to identify the according encoding information required to encode or decode the data object information.

Exceptions

Exception	Condition
ArgumentException	The type T does not define a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface or any data type specific attribute offers invalid information about the data type to associate with the Type.
ArgumentNullException	The dataTypeId or dataTypeEncodings or one of its items is a null reference (Nothing in Visual Basic).

RegisterType(Type, OpcNodeId, params OpcEncoding[])

static · since v2.14

Registers the dataType specified as the data object type to create in case there a data instance is to be created for the type definition identified by the dataTypeId or by one of the dataTypeEncodings specified.

public static void RegisterType(
    Type dataType,
    OpcNodeId dataTypeId,
    params OpcEncoding[] dataTypeEncodings)

Public Shared Sub RegisterType(
    dataType As Type,
    dataTypeId As OpcNodeId,
    ParamArray dataTypeEncodings As OpcEncoding())

Parameters

Name	Type	Description
dataType	Type	The Type to use in case there a data object for the data type definition equals to the data type identifier defined using the OpcDataTypeAttribute is to be created. The type needs to provide either a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface and then needs to be a subclass of the OpcData class.
dataTypeId	OpcNodeId	The identifier of the type definition for which the dataType is to be used to create a data object instance.
dataTypeEncodings	params OpcEncoding[]	An array of OpcEncoding instances identifying the different encodings supported by the dataType specified. Using OpcEncoding instances enables the possibility to define OpcEncodingType specific identifiers to use to identify the according encoding information required to encode or decode the data object information.

Exceptions

Exception	Condition
ArgumentException	The type dataType does not define a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface or any data type specific attribute offers invalid information about the data type to associate with the Type.
ArgumentNullException	The dataType, dataTypeId or dataTypeEncodings or one of its items is a null reference (Nothing in Visual Basic).

RegisterTypeMapper

static · 2 overloads · since v2.27

Overload	Description
RegisterTypeMapper<T>()static · since v2.27	Registers the T implementing the IOpcDataTypeMapper interface as a custom mapper for data types.
RegisterTypeMapper(IOpcDataTypeMapper)static · since v2.27	Registers the mapper as a custom mapper for data types.

RegisterTypeMapper<T>()

static · since v2.27

Registers the T implementing the IOpcDataTypeMapper interface as a custom mapper for data types.

public static void RegisterTypeMapper<T>() where T : IOpcDataTypeMapper, new()

Public Shared Sub RegisterTypeMapper(Of T As {IOpcDataTypeMapper, New})()

Type parameters

Name	Description
T	The type implementing the IOpcDataTypeMapper interface and providing a default constructor.

Exceptions

Exception	Condition
ArgumentException	The T does not inherit from OpcDataTypeMapper nor defines any OpcDataTypeMapperAttribute to indicate which types are mapped to each other.

RegisterTypeMapper(IOpcDataTypeMapper)

static · since v2.27

Registers the mapper as a custom mapper for data types.

public static void RegisterTypeMapper(IOpcDataTypeMapper mapper)

Public Shared Sub RegisterTypeMapper(mapper As IOpcDataTypeMapper)

Parameters

Name	Type	Description
mapper	IOpcDataTypeMapper	The IOpcDataTypeMapper to register.

Exceptions

Exception	Condition
ArgumentException	The mapper does not inherit from OpcDataTypeMapper nor defines any OpcDataTypeMapperAttribute to indicate which types are mapped to each other.
ArgumentNullException	The mapper is a null reference (Nothing in Visual Basic).

RegisterTypes

static · 3 overloads

Overload	Description
RegisterTypes(Assembly)static	Registers all non-abstract types in the assembly specified which defines the OpcDataTypeAttribute.
RegisterTypes(IEnumerable<Type>)static	Registers the dataTypes specified as the data object type to create in case there a data instance is to be created for the type definitions identified by the OpcEventTypeAttribute used on one of the dataTypes specified.
RegisterTypes(Type, params Type[])static	Registers the dataType and the further specified dataTypes as the data object type to create in case there a data instance is to be created for the type definition identified by the OpcDataTypeAttribute used on the dataType or on one of the dataTypes specified.

Exceptions (all overloads)

Exception	Condition
ArgumentException	A Type does not define a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface or any data type specific attribute offers invalid information about the data type to associate with the Type.

RegisterTypes(Assembly)

static

Registers all non-abstract types in the assembly specified which defines the OpcDataTypeAttribute.

public static void RegisterTypes(Assembly assembly)

Public Shared Sub RegisterTypes(assembly As Assembly)

Parameters

Name	Type	Description
assembly	Assembly	The Assembly its types are inspected for types which using the OpcDataTypeAttribute.

Exceptions

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

Remarks

The Type instances to register need to define the OpcDataTypeAttribute and either a public accessible parameterless constructor or a public accessible constructor accepting an instance of the IOpcDataStore interface and then needs to be a subclass of the OpcData class.

RegisterTypes(IEnumerable<Type>)

static

Registers the dataTypes specified as the data object type to create in case there a data instance is to be created for the type definitions identified by the OpcEventTypeAttribute used on one of the dataTypes specified.

public static void RegisterTypes(IEnumerable<Type> dataTypes)

Public Shared Sub RegisterTypes(dataTypes As IEnumerable(Of Type))

Parameters

Name	Type	Description
dataTypes	IEnumerable<Type>	A sequence of Type instances representing the types to use in case there a data object for the data definition equals to the data type identifier defined using the OpcDataTypeAttribute is to be created.

Exceptions

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

Remarks

Any null reference (Nothing in Visual Basic) in dataTypes is ignored.

RegisterTypes(Type, params Type[])

static

Registers the dataType and the further specified dataTypes as the data object type to create in case there a data instance is to be created for the type definition identified by the OpcDataTypeAttribute used on the dataType or on one of the dataTypes specified.

public static void RegisterTypes(Type dataType, params Type[] dataTypes)

Public Shared Sub RegisterTypes(
    dataType As Type,
    ParamArray dataTypes As Type())

Parameters

Name	Type	Description
dataType	Type	The Type instance to use in case there a data object for the data definition equals to the data type identifier defined using the OpcDataTypeAttribute is to be created.
dataTypes	params Type[]	An array of additional Type instances to use in case there a data object for the data definitions equals to the data type identifier defined using the OpcDataTypeAttribute is to be created.

Exceptions

Exception	Condition
ArgumentNullException	The dataType or dataTypes is a null reference (Nothing in Visual Basic).

ShallowCopy

protected · virtual

Creates a shallow copy of the current OpcData.

protected virtual object ShallowCopy()

Protected Overridable Function ShallowCopy() As Object

Returns

Object

A new object which is a shallow copy of the current OpcData.

ToExtension

static · since v2.40

Wraps the instance into an ExtensionObject, so that it can be encoded as the instance of its data type.

public static ExtensionObject ToExtension(object instance)

Public Shared Function ToExtension(instance As Object) As ExtensionObject

Parameters

Name	Type	Description
instance	Object	The instance of a data type to wrap.

Returns

ExtensionObject

A new ExtensionObject whose body holds the instance wrapped for the encoding (see To), or the instance itself if it already is an ExtensionObject.

TryGetTypeMapper

static · 3 overloads · since v2.27

Overload	Description
TryGetTypeMapper<TSource>(out IOpcDataTypeMapper)static · since v2.27	Determines the IOpcDataTypeMapper associated with the type specified by TSource.
TryGetTypeMapper(Type, out IOpcDataTypeMapper)static · since v2.27	Determines the IOpcDataTypeMapper associated with the type specified by sourceType.
TryGetTypeMapper(Type, out IOpcDataTypeMapper, out Type)static · since v2.27	Determines the IOpcDataTypeMapper associated with the type specified by sourceType and the resulting targetType.

TryGetTypeMapper<TSource>(out IOpcDataTypeMapper)

static · since v2.27

Determines the IOpcDataTypeMapper associated with the type specified by TSource.

public static bool TryGetTypeMapper<TSource>(out IOpcDataTypeMapper mapper)

Public Shared Function TryGetTypeMapper(Of TSource)(
    mapper As IOpcDataTypeMapper) As Boolean

Type parameters

Name	Description
TSource	The Type its mapper is to be determined.

Parameters

Name	Type	Description
mapper	out IOpcDataTypeMapper	The IOpcDataTypeMapper which is responsible for object's of the type specified by TSource or a null reference (Nothing in Visual Basic) if there does not exist a mapper for the type specified by TSource.

Returns

Boolean

The value true if a mapper exists for the type specified by the TSource type; otherwise the value false.

TryGetTypeMapper(Type, out IOpcDataTypeMapper)

static · since v2.27

Determines the IOpcDataTypeMapper associated with the type specified by sourceType.

public static bool TryGetTypeMapper(
    Type sourceType,
    out IOpcDataTypeMapper mapper)

Public Shared Function TryGetTypeMapper(
    sourceType As Type,
    mapper As IOpcDataTypeMapper) As Boolean

Parameters

Name	Type	Description
sourceType	Type	The Type its mapper is to be determined.
mapper	out IOpcDataTypeMapper	The IOpcDataTypeMapper which is responsible for object's of the type specified by sourceType or a null reference (Nothing in Visual Basic) if there does not exist a mapper for the type specified by sourceType.

Returns

Boolean

The value true if a mapper exists for the type specified by sourceType; otherwise the value false.

Exceptions

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

TryGetTypeMapper(Type, out IOpcDataTypeMapper, out Type)

static · since v2.27

Determines the IOpcDataTypeMapper associated with the type specified by sourceType and the resulting targetType.

public static bool TryGetTypeMapper(
    Type sourceType,
    out IOpcDataTypeMapper mapper,
    out Type targetType)

Public Shared Function TryGetTypeMapper(
    sourceType As Type,
    mapper As IOpcDataTypeMapper,
    targetType As Type) As Boolean

Parameters

Name	Type	Description
sourceType	Type	The Type its mapper is to be determined.
mapper	out IOpcDataTypeMapper	The IOpcDataTypeMapper which is responsible for object's of the type specified by sourceType or a null reference (Nothing in Visual Basic) if there does not exist a mapper for the type specified by sourceType.
targetType	out Type	The Type the sourceType is mapped to by the associated mapper or a null reference (Nothing in Visual Basic) if there does not exist a mapper for the type specified by sourceType.

Returns

Boolean

The value true if a mapper exists for the type specified by sourceType; otherwise the value false.

Exceptions

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

UnregisterType

static · 3 overloads

Overload	Description
UnregisterType<T>()static	Unregisters the previously registered (see RegisterType) type defined by T as the object type to not longer create for the type definition identified by the OpcDataTypeAttribute defined on the T specified.
UnregisterType<T>(OpcNodeId)static	Unregisters the previously registered (see RegisterType) type defined by T as the object type to not longer create for the type definition identified by the dataTypeId specified.
UnregisterType<T>(OpcNodeId, params OpcEncoding[])static	Unregisters the previously registered (see RegisterType) type defined by T as the object type to not longer create for the type definition identified by the dataTypeId or by one of the dataTypeEncodings specified.

UnregisterType<T>()

static

Unregisters the previously registered (see RegisterType) type defined by T as the object type to not longer create for the type definition identified by the OpcDataTypeAttribute defined on the T specified.

public static void UnregisterType<T>()

Public Shared Sub UnregisterType(Of T)()

Type parameters

Name	Description
T	The data type to unregister for the data definition equals to data type identifier defined using the OpcDataTypeAttribute.

UnregisterType<T>(OpcNodeId)

static

Unregisters the previously registered (see RegisterType) type defined by T as the object type to not longer create for the type definition identified by the dataTypeId specified.

public static void UnregisterType<T>(OpcNodeId dataTypeId)

Public Shared Sub UnregisterType(Of T)(dataTypeId As OpcNodeId)

Type parameters

Name	Description
T	The data type to unregister for the data definition equals to dataTypeId.

Parameters

Name	Type	Description
dataTypeId	OpcNodeId	The identifier of the type definition for which the T is to be unregistered.

Exceptions

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

UnregisterType<T>(OpcNodeId, params OpcEncoding[])

static

Unregisters the previously registered (see RegisterType) type defined by T as the object type to not longer create for the type definition identified by the dataTypeId or by one of the dataTypeEncodings specified.

public static void UnregisterType<T>(
    OpcNodeId dataTypeId,
    params OpcEncoding[] dataTypeEncodings)

Public Shared Sub UnregisterType(Of T)(
    dataTypeId As OpcNodeId,
    ParamArray dataTypeEncodings As OpcEncoding())

Type parameters

Name	Description
T	The data type to unregister for the data definition equals to dataTypeId or one of the dataTypeEncodings.

Parameters

Name	Type	Description
dataTypeId	OpcNodeId	The identifier of the type definition for which the T is to be unregistered.
dataTypeEncodings	params OpcEncoding[]	An array of OpcEncoding instances identifying the different encodings supported by the T specified for which the T is to be unregistered as well.

Exceptions

Exception	Condition
ArgumentNullException	The dataTypeId or dataTypeEncodings or one of its items is a null reference (Nothing in Visual Basic).

UnregisterTypeMapper

static · 2 overloads · since v2.27

Overload	Description
UnregisterTypeMapper<T>()static · since v2.27	Unregisters the T implementing the IOpcDataTypeMapper interface as a custom mapper for data types.
UnregisterTypeMapper(IOpcDataTypeMapper)static · since v2.27	Unregisters the mapper as a custom mapper for data types.

UnregisterTypeMapper<T>()

static · since v2.27

Unregisters the T implementing the IOpcDataTypeMapper interface as a custom mapper for data types.

public static void UnregisterTypeMapper<T>() where T : IOpcDataTypeMapper, new()

Public Shared Sub UnregisterTypeMapper(Of T As {IOpcDataTypeMapper, New})()

Type parameters

Name	Description
T	The type implementing the IOpcDataTypeMapper interface.

Exceptions

Exception	Condition
ArgumentException	The T does not inherit from OpcDataTypeMapper nor defines any OpcDataTypeMapperAttribute to indicate which types are mapped to each other.

UnregisterTypeMapper(IOpcDataTypeMapper)

static · since v2.27

Unregisters the mapper as a custom mapper for data types.

public static void UnregisterTypeMapper(IOpcDataTypeMapper mapper)

Public Shared Sub UnregisterTypeMapper(mapper As IOpcDataTypeMapper)

Parameters

Name	Type	Description
mapper	IOpcDataTypeMapper	The IOpcDataTypeMapper to unregister.

Exceptions

Exception	Condition
ArgumentException	The mapper does not inherit from OpcDataTypeMapper nor defines any OpcDataTypeMapperAttribute to indicate which types are mapped to each other.
ArgumentNullException	The mapper is a null reference (Nothing in Visual Basic).

UnregisterTypes

static · 3 overloads

Overload	Description
UnregisterTypes(Assembly)static	Unregisters all previously registered types (see RegisterTypes) in the assembly specified.
UnregisterTypes(IEnumerable<Type>)static	Unregisters the previously registered (see RegisterTypes) dataTypes specified.
UnregisterTypes(Type, params Type[])static	Unregisters the previously registered dataType and the further specified dataTypes (see RegisterTypes).

UnregisterTypes(Assembly)

static

Unregisters all previously registered types (see RegisterTypes) in the assembly specified.

public static void UnregisterTypes(Assembly assembly)

Public Shared Sub UnregisterTypes(assembly As Assembly)

Parameters

Name	Type	Description
assembly	Assembly	The Assembly its types are inspected for types using the OpcDataTypeAttribute.

Exceptions

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

UnregisterTypes(IEnumerable<Type>)

static

Unregisters the previously registered (see RegisterTypes) dataTypes specified.

public static void UnregisterTypes(IEnumerable<Type> dataTypes)

Public Shared Sub UnregisterTypes(dataTypes As IEnumerable(Of Type))

Parameters

Name	Type	Description
dataTypes	IEnumerable<Type>	A sequence of Type instances to unregister for the data definitions equals to the data type identifiers defined using the OpcDataTypeAttribute.

Exceptions

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

UnregisterTypes(Type, params Type[])

static

Unregisters the previously registered dataType and the further specified dataTypes (see RegisterTypes).

public static void UnregisterTypes(Type dataType, params Type[] dataTypes)

Public Shared Sub UnregisterTypes(
    dataType As Type,
    ParamArray dataTypes As Type())

Parameters

Name	Type	Description
dataType	Type	The Type instance to unregister for the data definitions equals to the data type identifiers defined using the OpcDataTypeAttribute.
dataTypes	params Type[]

Exceptions

Exception	Condition
ArgumentNullException	The dataType or dataTypes is a null reference (Nothing in Visual Basic).

Events

TypeResolve

static

Occurs when the resolution of a data type fails. Use this event to manually provide the Type to use for a specific data type definition identifier.

public static event OpcTypeResolveEventHandler TypeResolve

Public Shared Event TypeResolve As OpcTypeResolveEventHandler

Event type

OpcTypeResolveEventHandler