Reference

IOpcDataTypeInfo Members

Type

IOpcDataTypeInfo

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Properties

BaseType

Gets the type from which the current IOpcDataTypeInfo directly inherits.

IOpcDataTypeInfo BaseType { get; }

ReadOnly Property BaseType As IOpcDataTypeInfo

Property value

IOpcDataTypeInfo

An instance of the IOpcDataTypeInfo which represents the type from which the current IOpcDataTypeInfo directly inherits or a null reference (Nothing in Visual Basic) if the type does not inherit from a different IOpcDataTypeInfo.

Encoding

Gets the information used to identify the type of encoding used for the data of the type represented.

OpcEncoding Encoding { get; }

ReadOnly Property Encoding As OpcEncoding

Property value

OpcEncoding

An instance of the OpcEncoding class which represents the information used to encode data of the type or a null reference (Nothing in Visual Basic) if is no encoding information associated with the type.

EncodingMask

Gets the characteristics used to encode the existence of optional fields.

OpcEncodingMask EncodingMask { get; }

ReadOnly Property EncodingMask As OpcEncodingMask

Property value

OpcEncodingMask

An instance of the OpcEncodingMask class.

Encodings

Gets information of all encodings supported by the type represented.

OpcEncoding[] Encodings { get; }

ReadOnly Property Encodings As OpcEncoding()

Property value

OpcEncoding[]

An array of OpcEncoding instances supported by the type.

IsArray

Gets a value indicating whether the type is an array.

bool IsArray { get; }

ReadOnly Property IsArray As Boolean

Property value

Boolean

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

IsEnum

Gets a value indicating whether the current IOpcDataTypeInfo represents an enumeration.

bool IsEnum { get; }

ReadOnly Property IsEnum As Boolean

Property value

Boolean

The value true if the current IOpcDataTypeInfo represents an enumeration; otherwise the value false.

Remarks

The OPC UA handles enumerations as a numeric value that has a fixed set of valid values. The encoded value described by an enumeration is always an unsigned integer (see uint) with a fixed size.

IsOpaque

Gets a value indicating whether the current IOpcDataTypeInfo describes a primitive fixed size type.

bool IsOpaque { get; }

ReadOnly Property IsOpaque As Boolean

Property value

Boolean

The value true if the current IOpcDataTypeInfo represents an opaque type; otherwise the value false.

IsPrimitive

Gets a value indicating whether the IOpcDataTypeInfo is one of the primitive types.

bool IsPrimitive { get; }

ReadOnly Property IsPrimitive As Boolean

Property value

Boolean

The value true if the IOpcDataTypeInfo is one of the primitive types; otherwise the value false.

IsStruct

Gets a value indicating whether the IOpcDataTypeInfo is a structured type; that is not a value type.

bool IsStruct { get; }

ReadOnly Property IsStruct As Boolean

Property value

Boolean

The value true if the IOpcDataTypeInfo is a structured type; otherwise the value false.

Remarks

The OPC UA handles structures as a sequence of values. Each value in the sequence is called a field. A field may specify that zero, one or multiple instances of the type appear within the sequence described by the structure. Some fields have lengths that are not multiples of 8 bits. Several of these fields may appear in a sequence in a structure, however, the total number of bits used in the sequence shall be aligned on a byte boundary. A sequence of fields which do not line up on byte boundaries are specified from the least significant bit to the most significant bit. Sequences which are longer than one byte overflow from the most significant bit to the first byte into the least significant bit of the next byte.

IsSystemType

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

bool IsSystemType { get; }

ReadOnly Property IsSystemType As Boolean

Property value

Boolean

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

IsUnion

since v2.32

Gets a value indicating whether the current IOpcDataTypeInfo represents a type which is only transported using a field indicator and the field indicated.

bool IsUnion { get; }

ReadOnly Property IsUnion As Boolean

Property value

Boolean

The value true if the current data type represents an union type; otherwise the value false.

Name

Gets a value which defines the non-localizable human-readable name of the type represented. A node which represents this IOpcDataTypeInfo uses the Name as its BrowseName.

OpcName Name { get; }

ReadOnly Property Name As OpcName

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 IOpcDataTypeInfo.

Size

Gets the size of the type represented as the number of bytes required.

long? Size { get; }

ReadOnly Property Size As Long?

Property value

Nullable<Int64>

The size of the type as the number of bytes required; if this IOpcDataTypeInfo represents a type with a fixed size (see IsOpaque).

SizeInBits

Gets the size of the type represented as the number of bits required.

long? SizeInBits { get; }

ReadOnly Property SizeInBits As Long?

Property value

Nullable<Int64>

The size of the type as the number of bits required; if this IOpcDataTypeInfo represents a type with a fixed size (see IsOpaque).

TypeId

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

OpcNodeId TypeId { get; }

ReadOnly Property TypeId As OpcNodeId

Property value

OpcNodeId

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

UnderlyingType

Gets the type which provides the implementation of the IOpcDataTypeInfo.

Type UnderlyingType { get; }

ReadOnly Property UnderlyingType As Type

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 IOpcDataTypeInfo.

Methods

GetArrayRank

Gets the number of dimensions in an array.

int GetArrayRank()

Function GetArrayRank() As Integer

Returns

Int32

An integer that contains the number of dimensions in the current type.

Exceptions

Exception	Condition
ArgumentException	The current type is not an array.

GetElementType

Returns the IOpcDataTypeInfo of the object encompassed or referred to by the current array.

IOpcDataTypeInfo GetElementType()

Function GetElementType() As IOpcDataTypeInfo

Returns

IOpcDataTypeInfo

The IOpcDataTypeInfo of the object encompassed or referred to by the current array or null if the current IOpcDataTypeInfo is not an array.

GetField

Searches for the field with the specified name.

IOpcDataFieldInfo GetField(string name)

Function GetField(name As String) As IOpcDataFieldInfo

Parameters

Name	Type	Description
name	String	The string containing the name of the data field to get.

Returns

IOpcDataFieldInfo

An instance of the IOpcDataFieldInfo representing the field with the specified name, if found; otherwise a null reference (Nothing in Visual Basic).

Exceptions

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

Remarks

The name specified is compared using Ordinal.

GetFields

Returns all the fields of the current IOpcDataTypeInfo.

IOpcDataFieldInfo[] GetFields()

Function GetFields() As IOpcDataFieldInfo()

Returns

IOpcDataFieldInfo[]

An array of IOpcDataFieldInfo objects representing all the fields defined for the current IOpcDataTypeInfo or an empty array of type IOpcDataFieldInfo if no fields are defined for the current IOpcDataTypeInfo.

MakeArrayType

2 overloads

Overload	Description
MakeArrayType()	Returns a IOpcDataTypeInfo object representing a one-dimensional array of the current type, with a lower bound of zero.
MakeArrayType(int)	Returns a IOpcDataTypeInfo object representing an array of the current type, with the specified number of dimensions.

MakeArrayType()

Returns a IOpcDataTypeInfo object representing a one-dimensional array of the current type, with a lower bound of zero.

IOpcDataTypeInfo MakeArrayType()

Function MakeArrayType() As IOpcDataTypeInfo

Returns

IOpcDataTypeInfo

A IOpcDataTypeInfo object representing a one-dimensional array of the current type, with a lower bound of zero.

MakeArrayType(int)

Returns a IOpcDataTypeInfo object representing an array of the current type, with the specified number of dimensions.

IOpcDataTypeInfo MakeArrayType(int rank)

Function MakeArrayType(rank As Integer) As IOpcDataTypeInfo

Parameters

Name	Type	Description
rank	Int32	The number of dimensions for the array. This number must be less than or equal to 32.

Returns

IOpcDataTypeInfo

An object representing an array of the current type, with the specified number of dimensions.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The rank is not between 1 and 32 (inclusive).