Reference

OpcDataTypes Members

Type

OpcDataTypes

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Fields

Boolean

static

Identifies the Boolean data type.

public static readonly OpcNodeId Boolean

Public Shared ReadOnly [Boolean] As OpcNodeId

Field value

OpcNodeId

Byte

static

Identifies the Byte data type.

public static readonly OpcNodeId Byte

Public Shared ReadOnly [Byte] As OpcNodeId

Field value

OpcNodeId

ByteString

static

Identifies the ByteString data type.

public static readonly OpcNodeId ByteString

Public Shared ReadOnly ByteString As OpcNodeId

Field value

OpcNodeId

DateTime

static

Identifies the DateTime data type.

public static readonly OpcNodeId DateTime

Public Shared ReadOnly DateTime As OpcNodeId

Field value

OpcNodeId

DiagnosticInfo

static

Identifies the DiagnosticInfo data type.

public static readonly OpcNodeId DiagnosticInfo

Public Shared ReadOnly DiagnosticInfo As OpcNodeId

Field value

OpcNodeId

Double

static

Identifies the Double data type.

public static readonly OpcNodeId Double

Public Shared ReadOnly [Double] As OpcNodeId

Field value

OpcNodeId

EngineeringUnitInfo

static

Identifies the EUInformation data type.

public static readonly OpcNodeId EngineeringUnitInfo

Public Shared ReadOnly EngineeringUnitInfo As OpcNodeId

Field value

OpcNodeId

Enumeration

static

Identifies the Enumeration data type.

public static readonly OpcNodeId Enumeration

Public Shared ReadOnly Enumeration As OpcNodeId

Field value

OpcNodeId

ExpandedNodeId

static

Identifies the ExpandedNodeId data type.

public static readonly OpcNodeId ExpandedNodeId

Public Shared ReadOnly ExpandedNodeId As OpcNodeId

Field value

OpcNodeId

Float

static

Identifies the Float data type.

public static readonly OpcNodeId Float

Public Shared ReadOnly Float As OpcNodeId

Field value

OpcNodeId

Guid

static

Identifies the Guid data type.

public static readonly OpcNodeId Guid

Public Shared ReadOnly Guid As OpcNodeId

Field value

OpcNodeId

Int16

static

Identifies the Int16 data type.

public static readonly OpcNodeId Int16

Public Shared ReadOnly Int16 As OpcNodeId

Field value

OpcNodeId

Int32

static

Identifies the Int32 data type.

public static readonly OpcNodeId Int32

Public Shared ReadOnly Int32 As OpcNodeId

Field value

OpcNodeId

Int64

static

Identifies the Int64 data type.

public static readonly OpcNodeId Int64

Public Shared ReadOnly Int64 As OpcNodeId

Field value

OpcNodeId

Integer

static

Identifies the Integer data type.

public static readonly OpcNodeId Integer

Public Shared ReadOnly [Integer] As OpcNodeId

Field value

OpcNodeId

LocalizedText

static

Identifies the LocalizedText data type.

public static readonly OpcNodeId LocalizedText

Public Shared ReadOnly LocalizedText As OpcNodeId

Field value

OpcNodeId

NodeId

static

Identifies the NodeId data type.

public static readonly OpcNodeId NodeId

Public Shared ReadOnly NodeId As OpcNodeId

Field value

OpcNodeId

Number

static

Identifies the Number data type.

public static readonly OpcNodeId Number

Public Shared ReadOnly Number As OpcNodeId

Field value

OpcNodeId

QualifiedName

static

Identifies the QualifiedName data type.

public static readonly OpcNodeId QualifiedName

Public Shared ReadOnly QualifiedName As OpcNodeId

Field value

OpcNodeId

SByte

static

Identifies the SByte data type.

public static readonly OpcNodeId SByte

Public Shared ReadOnly [SByte] As OpcNodeId

Field value

OpcNodeId

Status

static

Identifies the StatusCode data type.

public static readonly OpcNodeId Status

Public Shared ReadOnly Status As OpcNodeId

Field value

OpcNodeId

String

static

Identifies the String data type.

public static readonly OpcNodeId String

Public Shared ReadOnly [String] As OpcNodeId

Field value

OpcNodeId

UInt16

static

Identifies the UInt16 data type.

public static readonly OpcNodeId UInt16

Public Shared ReadOnly UInt16 As OpcNodeId

Field value

OpcNodeId

UInt32

static

Identifies the UInt32 data type.

public static readonly OpcNodeId UInt32

Public Shared ReadOnly UInt32 As OpcNodeId

Field value

OpcNodeId

UInt64

static

Identifies the UInt64 data type.

public static readonly OpcNodeId UInt64

Public Shared ReadOnly UInt64 As OpcNodeId

Field value

OpcNodeId

UInteger

static

Identifies the UInteger data type.

public static readonly OpcNodeId UInteger

Public Shared ReadOnly [UInteger] As OpcNodeId

Field value

OpcNodeId

Value

static

Identifies the DataValue data type.

public static readonly OpcNodeId Value

Public Shared ReadOnly Value As OpcNodeId

Field value

OpcNodeId

ValueRange

static

Identifies the Range data type.

public static readonly OpcNodeId ValueRange

Public Shared ReadOnly ValueRange As OpcNodeId

Field value

OpcNodeId

XmlElement

static

Identifies the XmlElement data type.

public static readonly OpcNodeId XmlElement

Public Shared ReadOnly XmlElement As OpcNodeId

Field value

OpcNodeId

Methods

GetArrayDimensions

static · 4 overloads

Overload	Description
GetArrayDimensions<T>()static · since v2.9	Determines the array dimensions of the type specified by T.
GetArrayDimensions<T>(T)static · since v2.9	Determines the array dimensions of the value specified.
GetArrayDimensions(Type)static · since v2.18	Determines the array dimensions of the type specified.
GetArrayDimensions(Type, object)static · since v2.18	Determines the array dimensions of the value specified, or of the type specified if there is no value.

GetArrayDimensions<T>()

static · since v2.9

Determines the array dimensions of the type specified by T.

public static OpcArrayDimensions GetArrayDimensions<T>()

Public Shared Function GetArrayDimensions(Of T)() As OpcArrayDimensions

Type parameters

Name	Description
T	The type whose array dimensions are to be determined.

Returns

OpcArrayDimensions

The array dimensions with the length 0 for each dimension if T is an array type; otherwise a null reference (Nothing in Visual Basic).

GetArrayDimensions<T>(T)

static · since v2.9

Determines the array dimensions of the value specified.

public static OpcArrayDimensions GetArrayDimensions<T>(T value)

Public Shared Function GetArrayDimensions(Of T)(
    value As T) As OpcArrayDimensions

Type parameters

Name	Description
T	The type of the value.

Parameters

Name	Type	Description
value	T	The value whose array dimensions are to be determined.

Returns

OpcArrayDimensions

The lengths of the dimensions if the value is an array; the length 0 for each dimension if the type of the value, or T for a null reference (Nothing in Visual Basic), is an array type; otherwise a null reference.

GetArrayDimensions(Type)

static · since v2.18

Determines the array dimensions of the type specified.

public static OpcArrayDimensions GetArrayDimensions(Type type)

Public Shared Function GetArrayDimensions(type As Type) As OpcArrayDimensions

Parameters

Name	Type	Description
type	Type	The type whose array dimensions are to be determined.

Returns

OpcArrayDimensions

The array dimensions with the length 0 for each dimension if the type is an array type; otherwise a null reference (Nothing in Visual Basic).

Exceptions

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

GetArrayDimensions(Type, object)

static · since v2.18

Determines the array dimensions of the value specified, or of the type specified if there is no value.

public static OpcArrayDimensions GetArrayDimensions(Type type, object value)

Public Shared Function GetArrayDimensions(
    type As Type,
    value As Object) As OpcArrayDimensions

Parameters

Name	Type	Description
type	Type	The type whose array dimensions are used if the value is a null reference (Nothing in Visual Basic).
value	Object	The value whose array dimensions are to be determined.

Returns

OpcArrayDimensions

The array dimensions of the value (see GetArrayDimensions), or of the type (see GetArrayDimensions) if the value is a null reference.

Exceptions

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

GetDataType

static · 3 overloads

Overload	Description
GetDataType<T>()static	Determines the built-in data type of the type specified by T.
GetDataType(Type)static	Determines the built-in data type of the type specified.
GetDataType(OpcNodeId)static	Determines the data type represented by the identifier of a data type specified.

GetDataType<T>()

static

Determines the built-in data type of the type specified by T.

public static OpcDataType GetDataType<T>()

Public Shared Function GetDataType(Of T)() As OpcDataType

Type parameters

Name	Description
T	The type whose built-in data type is to be determined.

Returns

OpcDataType

The built-in data type (see GetDataType).

GetDataType(Type)

static

Determines the built-in data type of the type specified.

public static OpcDataType GetDataType(Type type)

Public Shared Function GetDataType(type As Type) As OpcDataType

Parameters

Name	Type	Description
type	Type	The type whose built-in data type is to be determined.

Returns

OpcDataType

The built-in data type of the data type of the type (see GetNodeId), or Null if the type is a null reference (Nothing in Visual Basic) or its data type is not defined by OPC UA.

Remarks

For an array type the data type of its elements is determined. Unlike GetDataType, the method results in the built-in type which encodes the data type, e.g. ExtensionObject for a structure and Variant for object.

GetDataType(OpcNodeId)

static

Determines the data type represented by the identifier of a data type specified.

public static OpcDataType GetDataType(OpcNodeId nodeId)

Public Shared Function GetDataType(nodeId As OpcNodeId) As OpcDataType

Parameters

Name	Type	Description
nodeId	OpcNodeId	The identifier of the data type.

Returns

OpcDataType

The member of OpcDataType whose identifier (see GetNodeId) is the nodeId, Object for any other data type, or Null if the nodeId is a null reference (Nothing in Visual Basic) or a null identifier.

GetDefaultValue

static · 2 overloads

Overload	Description
GetDefaultValue<T>()static	Determines the default value OPC UA defines for the data type of the type specified by T.
GetDefaultValue<T>(T)static	Determines the default value OPC UA defines for the data type of the type specified by T and the value rank of the value specified.

GetDefaultValue<T>()

static

Determines the default value OPC UA defines for the data type of the type specified by T.

public static T GetDefaultValue<T>()

Public Shared Function GetDefaultValue(Of T)() As T

Type parameters

Name	Description
T	The type whose default value is to be determined.

Returns

T

The default value of the data type (e.g. 0 for numbers) if it is a T; otherwise the default value of T.

GetDefaultValue<T>(T)

static

Determines the default value OPC UA defines for the data type of the type specified by T and the value rank of the value specified.

public static T GetDefaultValue<T>(T value)

Public Shared Function GetDefaultValue(Of T)(value As T) As T

Type parameters

Name	Description
T	The type whose default value is to be determined.

Parameters

Name	Type	Description
value	T	The value whose value rank is used (see GetValueRank).

Returns

T

The default value of the data type (e.g. 0 for numbers) if it is a T; otherwise the default value of T.

GetNodeId

static · 4 overloads

Overload	Description
GetNodeId<T>()static	Determines the identifier of the data type of the type specified by T.
GetNodeId(Type)static	Determines the identifier of the data type of the type specified.
GetNodeId(object)static	Determines the identifier of the data type of the value specified.
GetNodeId(OpcDataType)static	Determines the identifier of the data type represented by the type specified.

GetNodeId<T>()

static

Determines the identifier of the data type of the type specified by T.

public static OpcNodeId GetNodeId<T>()

Public Shared Function GetNodeId(Of T)() As OpcNodeId

Type parameters

Name	Description
T	The type whose data type is to be determined.

Returns

OpcNodeId

The identifier of the data type (see GetNodeId).

GetNodeId(Type)

static

Determines the identifier of the data type of the type specified.

public static OpcNodeId GetNodeId(Type type)

Public Shared Function GetNodeId(type As Type) As OpcNodeId

Parameters

Name	Type	Description
type	Type	The type whose data type is to be determined.

Returns

OpcNodeId

The identifier of the data type, or Null if the type is a null reference (Nothing in Visual Basic).

Remarks

For an array type the data type of its elements is determined. The type object results in the BaseDataType data type.

GetNodeId(object)

static

Determines the identifier of the data type of the value specified.

public static OpcNodeId GetNodeId(object value)

Public Shared Function GetNodeId(value As Object) As OpcNodeId

Parameters

Name	Type	Description
value	Object	The value whose data type is to be determined.

Returns

OpcNodeId

The identifier of the data type of the type of the value (see GetNodeId), or Null if the value is a null reference (Nothing in Visual Basic).

GetNodeId(OpcDataType)

static

Determines the identifier of the data type represented by the type specified.

public static OpcNodeId GetNodeId(OpcDataType type)

Public Shared Function GetNodeId(type As OpcDataType) As OpcNodeId

Parameters

Name	Type	Description
type	OpcDataType	The data type whose identifier is to be determined.

Returns

OpcNodeId

The identifier of the data type, or Null for Null, ExtensionObject, Variant and Object.

GetUnderlyingType

static · 2 overloads · since v2.10

Overload	Description
GetUnderlyingType(OpcDataType)static · since v2.10	Determines the .NET type used for values of the data type specified.
GetUnderlyingType(OpcNodeId)static · since v2.10	Determines the .NET type used for values of the data type with the identifier specified.

GetUnderlyingType(OpcDataType)

static · since v2.10

Determines the .NET type used for values of the data type specified.

public static Type GetUnderlyingType(OpcDataType type)

Public Shared Function GetUnderlyingType(type As OpcDataType) As Type

Parameters

Name	Type	Description
type	OpcDataType	The data type whose .NET type is to be determined.

Returns

Type

The .NET type (see GetUnderlyingType), or a null reference (Nothing in Visual Basic) for a data type without identifier (see GetNodeId).

GetUnderlyingType(OpcNodeId)

static · since v2.10

Determines the .NET type used for values of the data type with the identifier specified.

public static Type GetUnderlyingType(OpcNodeId nodeId)

Public Shared Function GetUnderlyingType(nodeId As OpcNodeId) As Type

Parameters

Name	Type	Description
nodeId	OpcNodeId	The identifier of the data type.

Returns

Type

The .NET type used for values of the data type (e.g. OpcText for LocalizedText), the .NET type of a data type defined by a .NET type, otherwise object; or a null reference (Nothing in Visual Basic) if the nodeId is a null reference or a null identifier.

GetValueRank

static · 4 overloads

Overload	Description
GetValueRank<T>()static	Determines the value rank of the type specified by T.
GetValueRank<T>(T)static	Determines the value rank of the value specified.
GetValueRank(Type)static	Determines the value rank of the type specified.
GetValueRank(Type, object)static	Determines the value rank of the value specified, or of the type specified if there is no value.

GetValueRank<T>()

static

Determines the value rank of the type specified by T.

public static int GetValueRank<T>()

Public Shared Function GetValueRank(Of T)() As Integer

Type parameters

Name	Description
T	The type whose value rank is to be determined.

Returns

Int32

The value rank (see GetValueRank).

GetValueRank<T>(T)

static

Determines the value rank of the value specified.

public static int GetValueRank<T>(T value)

Public Shared Function GetValueRank(Of T)(value As T) As Integer

Type parameters

Name	Description
T	The type of the value.

Parameters

Name	Type	Description
value	T	The value whose value rank is to be determined.

Returns

Int32

The value rank (see GetValueRank).

GetValueRank(Type)

static

Determines the value rank of the type specified.

public static int GetValueRank(Type type)

Public Shared Function GetValueRank(type As Type) As Integer

Parameters

Name	Type	Description
type	Type	The type whose value rank is to be determined.

Returns

Int32

The value rank (see GetValueRank).

Exceptions

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

GetValueRank(Type, object)

static

Determines the value rank of the value specified, or of the type specified if there is no value.

public static int GetValueRank(Type type, object value)

Public Shared Function GetValueRank(type As Type, value As Object) As Integer

Parameters

Name	Type	Description
type	Type	The type whose value rank is used if the value is a null reference (Nothing in Visual Basic).
value	Object	The value whose value rank is to be determined.

Returns

Int32

The value rank as defined by OPC UA: -1 for a scalar, otherwise the number of dimensions of the array.

Exceptions

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

Remarks

A byte array is a one-dimensional array; a ByteString is a scalar.