Reference

IOpcReadNodesService Members

Type

IOpcReadNodesService

Namespace

Opc.UaFx.Services

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Inherits members from IOpcService<OpcReadNodesResponse, OpcReadNodesRequest>.

Properties

MaxNodesPerRead

since v2.9

Gets or sets the maximum number of nodes which shall be read using a single read request. This number indirectly defines the number of requests used to send a specific number of read requests to the server.

uint? MaxNodesPerRead { get; set; }

Property MaxNodesPerRead As UInteger?

Property value

Nullable<UInt32>

The absolute number of read commands which shall be send to the server per request or a null reference (Nothing in Visual Basic). In case there a specific number of nodes is used, a request with more commands as the MaxNodesPerRead is partitioned into multiple requests and the responses of them are accumulated. The default value of this property is a null reference (Nothing in Visual Basic) and means that all commands defined are send to the server using the server defined number of nodes per read request.

UsedMaxNodesPerRead

since v2.9

Gets the maximum number of nodes which are read using a single read request. This property will use either the MaxNodesPerRead or the maximum number of nodes which can be read in one request as defined by the server. The lowest number of nodes is used to partition the commands to execute into multiple read requests.

uint? UsedMaxNodesPerRead { get; }

ReadOnly Property UsedMaxNodesPerRead As UInteger?

Property value

Nullable<UInt32>

In case there has already been one read attempt (with more than one read command) the definite number of commands per read request; otherwise a null reference (Nothing in Visual Basic).

Methods

ReadNodes

2 overloads

Overload	Description
ReadNodes(IEnumerable<OpcReadNode>)	Reads one or more values of one or more attributes of one or more nodes using the specified commands.
ReadNodes(params OpcReadNode[])	Reads one or more values to one or more attributes of one or more nodes using the specified commands.

Known results: BadNodeIdInvalid, BadNodeIdUnknown, BadAttributeInvalid, BadIndexRangeInvalid, BadIndexRangeNoData, BadDataEncodingInvalid, BadDataEncodingUnsupported, BadNotReadable, BadUserAccessDenied

Exceptions (all overloads)

Exception	Condition
InvalidOperationException	The read service is currently not supported, especially using the commands specified.
OpcException	The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo, BadTooManyOperations, BadMaxAgeInvalid and BadTimestampsToReturnInvalid.

ReadNodes(IEnumerable<OpcReadNode>)

Reads one or more values of one or more attributes of one or more nodes using the specified commands.

IEnumerable<OpcValue> ReadNodes(IEnumerable<OpcReadNode> commands)

Function ReadNodes(
    commands As IEnumerable(Of OpcReadNode)) As IEnumerable(Of OpcValue)

Parameters

Name	Type	Description
commands	IEnumerable<OpcReadNode>	A sequence of OpcReadNode instances to process.

Returns

IEnumerable<OpcValue>

A sequence of OpcValue instances its number and order of items matches the number and order of items in the commands sequence. There is for each command one entry which stores the value requested by that command.

Exceptions

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

ReadNodes(params OpcReadNode[])

Reads one or more values to one or more attributes of one or more nodes using the specified commands.

IEnumerable<OpcValue> ReadNodes(params OpcReadNode[] commands)

Function ReadNodes(
    ParamArray commands As OpcReadNode()) As IEnumerable(Of OpcValue)

Parameters

Name	Type	Description
commands	params OpcReadNode[]	An array of OpcReadNode instances to process.

Returns

IEnumerable<OpcValue>

A sequence of OpcValue instances its number and order of items matches the number and order of items in the commands sequence. There is for each command one entry which stores the value requested by that command.

Exceptions

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