Reference

OpcVariableNodeInfo Members

Type

OpcVariableNodeInfo

Namespace

Opc.UaFx.Client

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Inherits members from OpcInstanceNodeInfo, OpcNodeInfo.

Properties

AccessLevel

Gets the value of the AccessLevel attribute of the variable node represented.

public OpcAccessLevel AccessLevel { get; }

Public ReadOnly Property AccessLevel As OpcAccessLevel

Property value

OpcAccessLevel

One of the members defined by the OpcAccessLevel enumeration. For more information about the use of the AccessLevel attribute see AccessLevel and OpcAccessLevel.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the AccessLevel attribute is requested on-demand and is cached for subsequent calls. This means, that further AccessLevel attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

ArrayDimensions

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

public uint[] ArrayDimensions { get; }

Public ReadOnly Property ArrayDimensions As UInteger()

Property value

UInt32[]

A null reference (Nothing in Visual Basic) in case there the value of the variable node 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.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the ArrayDimensions attribute is requested on-demand and is cached for subsequent calls. This means, that further ArrayDimensions attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

ArrayLength

Gets the total number of elements in all the dimensions of the array value of the variable node 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 node represented; zero if there are no elements in the array.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the ArrayDimensions attribute is requested on-demand and is cached for subsequent calls. This means, that further ArrayDimensions attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

ArrayRank

Gets the rank (number of dimensions) of the array value of the variable node 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 node represented.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the ArrayDimensions attribute is requested on-demand and is cached for subsequent calls. This means, that further ArrayDimensions attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

DataType

Gets the OpcTypeNodeInfo about the data type node of the variable node represented.

public OpcTypeNodeInfo DataType { get; }

Public ReadOnly Property DataType As OpcTypeNodeInfo

Property value

OpcTypeNodeInfo

An instance of the OpcTypeNodeInfo representing the type definition of the variable node represented. In case there is no known type definition for the data type referenced by the variable node a null reference (Nothing in Visual Basic).

DataTypeId

Gets the OpcNodeId about the data type node of the variable node represented.

public OpcNodeId DataTypeId { get; }

Public ReadOnly Property DataTypeId As OpcNodeId

Property value

OpcNodeId

An instance of the OpcNodeId which identifies the type node definition of the variable node represented. In case there is no type definition for the type of value provided by the variable node represented a null reference (Nothing in Visual Basic).

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the DataType attribute is requested on-demand and is cached for subsequent calls. This means, that further DataType attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

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.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the ValueRank attribute is requested on-demand and is cached for subsequent calls. This means, that further ValueRank attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

IsHistorizing

Gets a value indicating whether the server is actively collecting data for the history of the variable node represented.

public bool IsHistorizing { get; }

Public ReadOnly Property IsHistorizing As Boolean

Property value

Boolean

The value true if the server is actively collecting historical data; otherwise the value false.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the IsHistorizing attribute is requested on-demand and is cached for subsequent calls. This means, that further IsHistorizing attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

UserAccessLevel

Gets the value of the UserAccessLevel attribute of the variable node represented.

public OpcAccessLevel UserAccessLevel { get; }

Public ReadOnly Property UserAccessLevel As OpcAccessLevel

Property value

OpcAccessLevel

One of the members defined by the OpcAccessLevel enumeration. For more information about the use of the UserAccessLevel attribute see AccessLevel and OpcAccessLevel.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the UserAccessLevel attribute is requested on-demand and is cached for subsequent calls. This means, that further UserAccessLevel attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

UserWriteAccess

Gets a mask that indicates which attributes are writable by the current user of the client of a node taking user access rights into account.

public OpcAttributeWriteAccess UserWriteAccess { get; }

Public ReadOnly Property UserWriteAccess As OpcAttributeWriteAccess

Property value

OpcAttributeWriteAccess

A logical combination of the members defined by the OpcAttributeWriteAccess enumeration indicating which OpcAttributes of the variable node represented are currently writable by the current user of the client.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the UserWriteAccess attribute is requested on-demand and is cached for subsequent calls. This means, that further UserWriteAccess attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

WriteAccess

Gets a mask that indicates which attributes are generally writable through the server not taking user access rights into account.

public OpcAttributeWriteAccess WriteAccess { get; }

Public ReadOnly Property WriteAccess As OpcAttributeWriteAccess

Property value

OpcAttributeWriteAccess

A logical combination of the members defined by the OpcAttributeWriteAccess enumeration indicating which OpcAttributes of the variable node represented are generally writable by the server.

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the WriteAccess attribute is requested on-demand and is cached for subsequent calls. This means, that further WriteAccess attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

Methods

GetArrayLength

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

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 node represented is not an array (see IsArray).

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the ArrayDimensions attribute is requested on-demand and is cached for subsequent calls. This means, that further ArrayDimensions attribute requests will take use of already retrieved attribute information and will not demand additional network resources.

GetArrayLowerBound

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

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

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 node represented is not an array (see IsArray).

Remarks

The time consumed by the first call of the property depends on the availability of the server, because of the ArrayDimensions attribute is requested on-demand and is cached for subsequent calls. This means, that further ArrayDimensions attribute requests will take use of already retrieved attribute information and will not demand additional network resources.