org.eclipse.milo.opcua.sdk.client.subscriptions

Class ManagedDataItem

java.lang.Object

org.eclipse.milo.opcua.sdk.client.subscriptions.ManagedItem

org.eclipse.milo.opcua.sdk.client.subscriptions.ManagedDataItem

public class ManagedDataItem
extends ManagedItem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ManagedDataItem.DataValueListener A callback that receives notification of new values for a ManagedDataItem.

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.subscriptions.ManagedItem

client, monitoredItem, subscription

Method Summary

Modifier and Type	Method and Description
ManagedDataItem.DataValueListener	addDataValueListener(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> consumer) Add a DataValue Consumer to this ManagedDataItem.
void	addDataValueListener(ManagedDataItem.DataValueListener dataValueListener) Add a ManagedDataItem.DataValueListener to this ManagedDataItem.
CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit>	deleteAsync() Delete this ManagedDataItem.
double	getSamplingInterval() Get this item's current sampling interval, i.e.
boolean	removeDataValueListener(ManagedDataItem.DataValueListener dataValueListener) Remove a ManagedDataItem.DataValueListener from this ManagedDataItem.
double	setSamplingInterval(double samplingInterval) Request a new sampling interval for this item.
CompletableFuture<Double>	setSamplingIntervalAsync(double samplingInterval) Request a new sampling interval for this item.
CompletableFuture<Double>	setSamplingIntervalAsync(double samplingInterval, BatchModifyMonitoredItems batch) Request a new sampling interval for this item as part of a batch operation.

Methods inherited from class org.eclipse.milo.opcua.sdk.client.subscriptions.ManagedItem

delete, getClient, getDiscardOldest, getMonitoredItem, getMonitoringMode, getNodeId, getQueueSize, getReadValueId, getStatusCode, getSubscription, getTimestampsToReturn, setDiscardOldest, setDiscardOldestAsync, setDiscardOldestAsync, setMonitoringMode, setMonitoringModeAsync, setMonitoringModeAsync, setQueueSize, setQueueSizeAsync, setQueueSizeAsync, setTimestampsToReturn, setTimestampsToReturnAsync, setTimestampsToReturnAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

deleteAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.util.Unit> deleteAsync()

Description copied from class: ManagedItem

Delete this ManagedDataItem.

This call completes asynchronously.

Specified by:

deleteAsync in class ManagedItem

Returns:

a CompletableFuture that completes successfully if the operation succeeds or completes exceptionally if an operation- or service-level error occurs.

getSamplingInterval

public double getSamplingInterval()

Get this item's current sampling interval, i.e. its revised sampling interval.

Returns:

this item's current sampling interval, i.e. its revised sampling interval.

See Also:

UaMonitoredItem.getRevisedSamplingInterval()

setSamplingInterval

public double setSamplingInterval(double samplingInterval)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Request a new sampling interval for this item.

Parameters:

samplingInterval - the new sampling interval to request.

Returns:

the new sampling interval, possibly revised by the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an operation- or service-level error occurs.

setSamplingIntervalAsync

public CompletableFuture<Double> setSamplingIntervalAsync(double samplingInterval)

Request a new sampling interval for this item.

This call completes asynchronously.

Parameters:

samplingInterval - the new sampling interval to request.

Returns:

a CompletableFuture that completes successfully with the new sampling interval, possibly revised by the server, or completes exceptionally if an operation- or service-level error occurs.

setSamplingIntervalAsync

public CompletableFuture<Double> setSamplingIntervalAsync(double samplingInterval,
                                                          BatchModifyMonitoredItems batch)

Request a new sampling interval for this item as part of a batch operation.

Parameters:

samplingInterval - the new sampling interval to request.

batch - the BatchModifyMonitoredItems operation.

Returns:

a CompletableFuture that completes successfully with the new sampling interval, possibly revised by the server, or completes exceptionally if an operation- or service-level error occurred.

addDataValueListener

public ManagedDataItem.DataValueListener addDataValueListener(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> consumer)

Add a DataValue Consumer to this ManagedDataItem.

consumer will be invoked any time a new DataValue arrives for this item.

The Consumer is transformed into the returned ManagedDataItem.DataValueListener that can later be removed.

Listeners should be added in the callback that happens during item creation in the ManagedSubscription.createDataItem(double, ReadValueId, Consumer) and ManagedSubscription.createDataItemsAsync(double, List, Consumer) to avoid a possible race condition between the initial value arriving and the listener being registered.

Parameters:

consumer - a DataValue Consumer.

Returns:

a ManagedDataItem.DataValueListener that can later be removed.

addDataValueListener

public void addDataValueListener(ManagedDataItem.DataValueListener dataValueListener)

Add a ManagedDataItem.DataValueListener to this ManagedDataItem.

listener will be invoked any time a new DataValue arrives for this item.

Listeners should be added in the callback that happens during item creation in the ManagedSubscription.createDataItem(double, ReadValueId, Consumer) and ManagedSubscription.createDataItemsAsync(double, List, Consumer) to avoid a possible race condition between the initial value arriving and the listener being registered.

Parameters:

dataValueListener - the ManagedDataItem.DataValueListener to add.

removeDataValueListener

public boolean removeDataValueListener(ManagedDataItem.DataValueListener dataValueListener)

Remove a ManagedDataItem.DataValueListener from this ManagedDataItem.

Parameters:

dataValueListener - the ManagedDataItem.DataValueListener to remove.

Returns:

true if the listener was removed.