Reference

OpcNodeValueExtensions Members

Type

OpcNodeValueExtensions

Namespace

Opc.UaFx.Client

Assembly

Opc.UaFx.Advanced.dll

Package

Opc.UaFx.Advanced v2.59.0

Also in

Opc.UaFx.Client

Methods

Read

static · 2 overloads

Overload	Description
Read<T>(OpcNodeValue<T>, OpcClient)static	Reads the value of the value attribute of the node represented by the node specified.
Read<T>(IEnumerable<OpcNodeValue<T>>, OpcClient)static	Reads one or more values of one or more value attributes of one or more nodes represented by the nodes specified.

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

Exceptions (all overloads)

Exception	Condition
ObjectDisposedException	The object has been disposed of.
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.

Read<T>(OpcNodeValue<T>, OpcClient)

static

Reads the value of the value attribute of the node represented by the node specified.

public static T Read<T>(this OpcNodeValue<T> node, OpcClient client)

Public Shared Function Read(Of T)(
    node As OpcNodeValue(Of T),
    client As OpcClient) As T

Type parameters

Name	Description
T	The type of value to read.

Parameters

Name	Type	Description
node	OpcNodeValue<T>	The OpcNodeValue<T> instance to process.
client	OpcClient	The OpcClient to use to read the value attribute of the node.

Returns

T

The T value read using the node.

Exceptions

Exception	Condition
ArgumentNullException	The node or client is a null reference (Nothing in Visual Basic).
InvalidOperationException	The read service is currently not supported, especially using the node or client specified.

Read<T>(IEnumerable<OpcNodeValue<T>>, OpcClient)

static

Reads one or more values of one or more value attributes of one or more nodes represented by the nodes specified.

public static T[] Read<T>(
    this IEnumerable<OpcNodeValue<T>> nodes,
    OpcClient client)

Public Shared Function Read(Of T)(
    nodes As IEnumerable(Of OpcNodeValue(Of T)),
    client As OpcClient) As T()

Type parameters

Name	Description
T	The type of value to read.

Parameters

Name	Type	Description
nodes	IEnumerable<OpcNodeValue<T>>	A sequence of OpcNodeValue<T> instances to process.
client	OpcClient	The OpcClient to use to read the value attributes of the nodes.

Returns

T[]

A sequence of T values read using the nodes specified. The number and order of items matches the number and order of items in the nodes sequence. There is for each node one entry which stores the value requested.

Exceptions

Exception	Condition
ArgumentNullException	The nodes sequence, one of its items or client is a null reference (Nothing in Visual Basic).
InvalidOperationException	The read service is currently not supported, especially using the nodes or client specified.

Write

static · 5 overloads

Overload	Description
Write<T>(OpcNodeValue<T>, OpcClient)static	Writes the value attribute of the node specified.
Write<T>(OpcNodeValue<T>, OpcClient, T)static	Writes the value attribute of the node using the value specified.
Write<T>(IEnumerable<OpcNodeValue<T>>, OpcClient)static	Writes one or more values to one or more value attributes of one or more nodes represented by the nodes specified.
Write<T>(IEnumerable<OpcNodeValue<T>>, OpcClient, IEnumerable<T>)static	Writes one or more values to one or more value attributes of one or more nodes represented by the nodes using the values specified.
Write<T>(IEnumerable<OpcNodeValue<T>>, OpcClient, params T[])static	Writes one or more values to one or more value attributes of one or more nodes represented by the nodes using the values specified.

Exceptions (all overloads)

Exception	Condition
ObjectDisposedException	The object has been disposed of.
OpcException	The service execution failed upon different circumstances; for more details see exception details. The following issues can lead to that exception: BadNothingToDo and BadTooManyOperations.

Write<T>(OpcNodeValue<T>, OpcClient)

static

Writes the value attribute of the node specified.

public static OpcStatus Write<T>(this OpcNodeValue<T> node, OpcClient client)

Public Shared Function Write(Of T)(
    node As OpcNodeValue(Of T),
    client As OpcClient) As OpcStatus

Type parameters

Name	Description
T

Parameters

Name	Type	Description
node	OpcNodeValue<T>	The OpcNodeValue<T> instance to process.
client	OpcClient	The OpcClient to use to write the value attribute of the node.

Returns

OpcStatus

An instance of the OpcStatus class which indicates the outcome of the operation for the node.

Exceptions

Exception	Condition
ArgumentNullException	The node or client is a null reference (Nothing in Visual Basic).
InvalidOperationException	The write service is currently not supported, especially using the node or client specified.

Remarks

Known results for the node specified are:

Status	Description
GoodCompletesAsynchronously	The value was successfully written to an intermediate system but the Server does not know if the data source was updated properly.
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadAttributeInvalid	For more details see BadAttributeInvalid.
BadIndexRangeInvalid	For more details see BadIndexRangeInvalid.
BadIndexRangeNoData	For more details see BadIndexRangeNoData.
BadWriteNotSupported	The requested write operation is not supported. If a client attempts to write any value, quality, timestamp combination and the server does not support the requested combination (which could be a single quantity such as just timestamp), then the Server shall not perform any write on this node and shall return this status for that node.
BadNotWritable	For more details see BadNotWritable.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadOutOfRange	If a client attempts to write a value outside the valid range like a value not contained in the enumeration data type of a node, the server shall return this status for that node.
BadTypeMismatch	For more details see BadTypeMismatch.
BadDataEncodingUnsupported	For more details see BadDataEncodingUnsupported.
BadNoCommunication	For more details see BadNoCommunication.

Write<T>(OpcNodeValue<T>, OpcClient, T)

static

Writes the value attribute of the node using the value specified.

public static OpcStatus Write<T>(
    this OpcNodeValue<T> node,
    OpcClient client,
    T value)

Public Shared Function Write(Of T)(
    node As OpcNodeValue(Of T),
    client As OpcClient,
    value As T) As OpcStatus

Type parameters

Name	Description
T

Parameters

Name	Type	Description
node	OpcNodeValue<T>	The OpcNodeValue<T> instance to process.
client	OpcClient	The OpcClient to use to write the value attribute of the node using the value.
value	T	The T value to write to the node.

Returns

OpcStatus

An instance of the OpcStatus class which indicates the outcome of the operation for the node.

Exceptions

Exception	Condition
ArgumentNullException	The node or client is a null reference (Nothing in Visual Basic).
InvalidOperationException	The write service is currently not supported, especially using the node or client specified.

Remarks

Known results for the node specified are:

Status	Description
GoodCompletesAsynchronously	The value was successfully written to an intermediate system but the Server does not know if the data source was updated properly.
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadAttributeInvalid	For more details see BadAttributeInvalid.
BadIndexRangeInvalid	For more details see BadIndexRangeInvalid.
BadIndexRangeNoData	For more details see BadIndexRangeNoData.
BadWriteNotSupported	The requested write operation is not supported. If a client attempts to write any value, quality, timestamp combination and the server does not support the requested combination (which could be a single quantity such as just timestamp), then the Server shall not perform any write on this node and shall return this status for that node.
BadNotWritable	For more details see BadNotWritable.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadOutOfRange	If a client attempts to write a value outside the valid range like a value not contained in the enumeration data type of a node, the server shall return this status for that node.
BadTypeMismatch	For more details see BadTypeMismatch.
BadDataEncodingUnsupported	For more details see BadDataEncodingUnsupported.
BadNoCommunication	For more details see BadNoCommunication.

Write<T>(IEnumerable<OpcNodeValue<T>>, OpcClient)

static

Writes one or more values to one or more value attributes of one or more nodes represented by the nodes specified.

public static OpcStatusCollection Write<T>(
    this IEnumerable<OpcNodeValue<T>> nodes,
    OpcClient client)

Public Shared Function Write(Of T)(
    nodes As IEnumerable(Of OpcNodeValue(Of T)),
    client As OpcClient) As OpcStatusCollection

Type parameters

Name	Description
T

Parameters

Name	Type	Description
nodes	IEnumerable<OpcNodeValue<T>>	A sequence of OpcNodeValue<T> instances to process.
client	OpcClient	The OpcClient to use to read the value attributes of the nodes.

Returns

OpcStatusCollection

An instance of the OpcStatusCollection its number and order of items matches the number and order of items in the nodes. There is for each node one entry which indicates the outcome of the operation for that node.

Exceptions

Exception	Condition
ArgumentNullException	The nodes sequence or one of its items or client is a null reference (Nothing in Visual Basic).
InvalidOperationException	The write service is currently not supported, especially using the nodes or client specified.

Remarks

Known results for the nodes specified are:

Status	Description
GoodCompletesAsynchronously	The value was successfully written to an intermediate system but the Server does not know if the data source was updated properly.
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadAttributeInvalid	For more details see BadAttributeInvalid.
BadIndexRangeInvalid	For more details see BadIndexRangeInvalid.
BadIndexRangeNoData	For more details see BadIndexRangeNoData.
BadWriteNotSupported	The requested write operation is not supported. If a client attempts to write any value, quality, timestamp combination and the server does not support the requested combination (which could be a single quantity such as just timestamp), then the Server shall not perform any write on this node and shall return this status for that node.
BadNotWritable	For more details see BadNotWritable.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadOutOfRange	If a client attempts to write a value outside the valid range like a value not contained in the enumeration data type of a node, the server shall return this status for that node.
BadTypeMismatch	For more details see BadTypeMismatch.
BadDataEncodingUnsupported	For more details see BadDataEncodingUnsupported.
BadNoCommunication	For more details see BadNoCommunication.

Write<T>(IEnumerable<OpcNodeValue<T>>, OpcClient, IEnumerable<T>)

static

Writes one or more values to one or more value attributes of one or more nodes represented by the nodes using the values specified.

public static OpcStatusCollection Write<T>(
    this IEnumerable<OpcNodeValue<T>> nodes,
    OpcClient client,
    IEnumerable<T> values)

Public Shared Function Write(Of T)(
    nodes As IEnumerable(Of OpcNodeValue(Of T)),
    client As OpcClient,
    values As IEnumerable(Of T)) As OpcStatusCollection

Type parameters

Name	Description
T

Parameters

Name	Type	Description
nodes	IEnumerable<OpcNodeValue<T>>	A sequence of OpcNodeValue<T> instances to process.
client	OpcClient	The OpcClient to use to read the value attributes of the nodes.
values	IEnumerable<T>	A sequence of T values to write.

Returns

OpcStatusCollection

An instance of the OpcStatusCollection its number and order of items matches the number and order of items in the nodes. There is for each node one entry which indicates the outcome of the operation for that node.

Exceptions

Exception	Condition
ArgumentException	The number of items in nodes does not match the number of items in values.
ArgumentNullException	The nodes sequence or one of its items, client or values is a null reference (Nothing in Visual Basic).
InvalidOperationException	The write service is currently not supported, especially using the nodes or client specified.

Remarks

Known results for the nodes specified are:

Status	Description
GoodCompletesAsynchronously	The value was successfully written to an intermediate system but the Server does not know if the data source was updated properly.
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadAttributeInvalid	For more details see BadAttributeInvalid.
BadIndexRangeInvalid	For more details see BadIndexRangeInvalid.
BadIndexRangeNoData	For more details see BadIndexRangeNoData.
BadWriteNotSupported	The requested write operation is not supported. If a client attempts to write any value, quality, timestamp combination and the server does not support the requested combination (which could be a single quantity such as just timestamp), then the Server shall not perform any write on this node and shall return this status for that node.
BadNotWritable	For more details see BadNotWritable.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadOutOfRange	If a client attempts to write a value outside the valid range like a value not contained in the enumeration data type of a node, the server shall return this status for that node.
BadTypeMismatch	For more details see BadTypeMismatch.
BadDataEncodingUnsupported	For more details see BadDataEncodingUnsupported.
BadNoCommunication	For more details see BadNoCommunication.

Write<T>(IEnumerable<OpcNodeValue<T>>, OpcClient, params T[])

static

Writes one or more values to one or more value attributes of one or more nodes represented by the nodes using the values specified.

public static OpcStatusCollection Write<T>(
    this IEnumerable<OpcNodeValue<T>> nodes,
    OpcClient client,
    params T[] values)

Public Shared Function Write(Of T)(
    nodes As IEnumerable(Of OpcNodeValue(Of T)),
    client As OpcClient,
    ParamArray values As T()) As OpcStatusCollection

Type parameters

Name	Description
T

Parameters

Name	Type	Description
nodes	IEnumerable<OpcNodeValue<T>>	A sequence of OpcNodeValue<T> instances to process.
client	OpcClient	The OpcClient to use to read the value attributes of the nodes.
values	params T[]	An array of T values to write.

Returns

OpcStatusCollection

An instance of the OpcStatusCollection its number and order of items matches the number and order of items in the nodes. There is for each node one entry which indicates the outcome of the operation for that node.

Exceptions

Exception	Condition
ArgumentException	The number of items in nodes does not match the number of items in values.
ArgumentNullException	The nodes sequence or one of its items, client or values is a null reference (Nothing in Visual Basic).
InvalidOperationException	The write service is currently not supported, especially using the nodes or client specified.

Remarks

Known results for the nodes specified are:

Status	Description
GoodCompletesAsynchronously	The value was successfully written to an intermediate system but the Server does not know if the data source was updated properly.
BadNodeIdInvalid	For more details see BadNodeIdInvalid.
BadNodeIdUnknown	For more details see BadNodeIdUnknown.
BadAttributeInvalid	For more details see BadAttributeInvalid.
BadIndexRangeInvalid	For more details see BadIndexRangeInvalid.
BadIndexRangeNoData	For more details see BadIndexRangeNoData.
BadWriteNotSupported	The requested write operation is not supported. If a client attempts to write any value, quality, timestamp combination and the server does not support the requested combination (which could be a single quantity such as just timestamp), then the Server shall not perform any write on this node and shall return this status for that node.
BadNotWritable	For more details see BadNotWritable.
BadUserAccessDenied	For more details see BadUserAccessDenied.
BadOutOfRange	If a client attempts to write a value outside the valid range like a value not contained in the enumeration data type of a node, the server shall return this status for that node.
BadTypeMismatch	For more details see BadTypeMismatch.
BadDataEncodingUnsupported	For more details see BadDataEncodingUnsupported.
BadNoCommunication	For more details see BadNoCommunication.