Reference

OpcVariableTypeInfo Members

Type

OpcVariableTypeInfo

Namespace

Opc.UaFx

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Inherits members from OpcNodeTypeInfo.

Properties

ArrayDimensions

abstract

Gets the length for each dimension of an array value of the variable type represented.

public abstract uint[] ArrayDimensions { get; }

Public MustOverride ReadOnly Property ArrayDimensions As UInteger()

Property value

UInt32[]

A null reference (Nothing in Visual Basic) in case there the value of the variable type represented is a scalar value; otherwise an uint array there each entry indicates a single dimension while the value of the entry defines the length of that dimension.

ArrayLength

Gets the total number of elements in all the dimensions of the array value of the variable type represented.

public long ArrayLength { get; }

Public ReadOnly Property ArrayLength As Long

Property value

Int64

The total number of elements in all the dimensions of the array value of the variable type represented; zero if there are no elements in the array.

ArrayRank

Gets the rank (number of dimensions) of the array value of the variable type represented. For example, a one-dimensional array returns 1, a two-dimensional array returns 2, and so on.

public int ArrayRank { get; }

Public ReadOnly Property ArrayRank As Integer

Property value

Int32

The rank (number of dimensions) of the array value of the variable type represented.

Category

override

Gets the NodeCategory attribute which identifies the kind of node and is therefore used to classify the node regarding its use and purpose.

public override sealed OpcNodeCategory Category { get; }

Public NotOverridable Overrides ReadOnly Property Category As OpcNodeCategory

Property value

OpcNodeCategory

The OpcVariableTypeInfo always provides the VariableType.

Overrides

Category

DataType

Gets the built-in data type of the value of the variable type represented.

public OpcDataType DataType { get; }

Public ReadOnly Property DataType As OpcDataType

Property value

OpcDataType

The member of OpcDataType which represents the DataTypeId (see GetDataType).

DataTypeId

abstract

Gets the identifier of the data type of the value of the variable type represented.

public abstract OpcNodeId DataTypeId { get; }

Public MustOverride ReadOnly Property DataTypeId As OpcNodeId

Property value

OpcNodeId

The OpcNodeId of the data type node which defines the type of data of the value of the variable type.

IsArray

Gets a value indicating whether the value of the variable represented is an array.

public bool IsArray { get; }

Public ReadOnly Property IsArray As Boolean

Property value

Boolean

The value true if the value of the variable represented is an array; otherwise the false.

ValueRank

abstract

Gets the value rank of the value of the variable type represented.

public abstract int ValueRank { get; }

Public MustOverride ReadOnly Property ValueRank As Integer

Property value

Int32

The value of the ValueRank attribute which indicates whether the value is a scalar or an array and the number of its dimensions, as defined by OPC UA.

Methods

AttributeValue

override

Retrieves the value of the attribute specified.

public override object AttributeValue(OpcAttribute attribute)

Public Overrides Function AttributeValue(attribute As OpcAttribute) As Object

Parameters

Name	Type	Description
attribute	OpcAttribute	One of the members defined by the OpcAttribute enumeration which identifies the attribute its value is queried.

Returns

Object

The value of the attribute specified or a null reference (Nothing in Visual Basic) in case there the value of the attribute is a null reference or it is not supported by the current OpcVariableTypeInfo.

Overrides

AttributeValue

GetArrayLength

Gets a 32-bit integer that represents the number of elements in the specified dimension of the array value of the variable type.

public long GetArrayLength(int dimension)

Public Function GetArrayLength(dimension As Integer) As Long

Parameters

Name	Type	Description
dimension	Int32	A zero-based dimension of the array value whose length needs to be determined.

Returns

Int64

A 32-bit integer that represents the number of elements in the specified dimension of the array value.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The dimension is less than zero or equals to or greater than ArrayRank.
InvalidOperationException	The value of the variable type represented is not an array (see IsArray).

GetArrayLowerBound

Gets the index of the first element of the specified dimension in the array value of the variable type.

public long GetArrayLowerBound(int dimension)

Public Function GetArrayLowerBound(dimension As Integer) As Long

Parameters

Name	Type	Description
dimension	Int32	A zero-based dimension of the array value whose starting index needs to be determined.

Returns

Int64

The index of the first element of the specified dimension in the array value.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The dimension is less than zero or equals to or greater than ArrayRank.
InvalidOperationException	The value of the variable type represented is not an array (see IsArray).

GetArrayUpperBound

Gets the index of the last element of the specified dimension in the array value of the variable type.

public long GetArrayUpperBound(int dimension)

Public Function GetArrayUpperBound(dimension As Integer) As Long

Parameters

Name	Type	Description
dimension	Int32	A zero-based dimension of the array value whose upper bound needs to be determined.

Returns

Int64

The index of the last element of the specified dimension in the array value, or -1 if the specified dimension is empty.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The dimension is less than zero or equals to or greater than ArrayRank.
InvalidOperationException	The value of the variable type represented is not an array (see IsArray).