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

Class OpcUaMonitoredItem

java.lang.Object

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

All Implemented Interfaces:

UaMonitoredItem

public class OpcUaMonitoredItem
extends Object
implements UaMonitoredItem

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.sdk.client.api.subscriptions.UaMonitoredItem

UaMonitoredItem.EventConsumer, UaMonitoredItem.ValueConsumer

Constructor Summary

Constructors

Constructor and Description

OpcUaMonitoredItem(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger clientHandle, org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId readValueId, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger monitoredItemId, org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode statusCode, double revisedSamplingInterval, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger revisedQueueSize, org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject filterResult, org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode, org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject monitoringFilter, boolean discardOldest, org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps)

Method Summary

Modifier and Type	Method and Description
OpcUaClient	getClient() Get the OpcUaClient that created this monitored item.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getClientHandle() Get the client-assigned id.
boolean	getDiscardOldest() Get the discard policy.
org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject	getFilterResult() Get the filter result ExtensionObject.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getMonitoredItemId() Get the server-assigned id.
org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject	getMonitoringFilter() Get the filter requested when the item was created.
org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode	getMonitoringMode() Get the MonitoringMode.
org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId	getReadValueId() Get the ReadValueId.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRequestedQueueSize() Get the last requested queue size.
double	getRequestedSamplingInterval() Get the last requested sampling interval.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getRevisedQueueSize() Get the revised queue size.
double	getRevisedSamplingInterval() Get the revised sampling interval.
org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode	getStatusCode() Get the StatusCode of the last operation.
org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn	getTimestamps() Get the TimestampsToReturn requested when the item was created.
void	setEventConsumer(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> consumer) Set the Consumer that will receive events as they arrive from the server.
void	setEventConsumer(UaMonitoredItem.EventConsumer eventConsumer) Set the UaMonitoredItem.EventConsumer that will receive events as they arrive from the server.
void	setValueConsumer(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> consumer) Set the Consumer that will receive values as they arrive from the server.
void	setValueConsumer(UaMonitoredItem.ValueConsumer valueConsumer) Set a UaMonitoredItem.ValueConsumer that will receive values as they arrive from the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpcUaMonitoredItem

public OpcUaMonitoredItem(OpcUaClient client,
                          org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger clientHandle,
                          org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId readValueId,
                          org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger monitoredItemId,
                          org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode statusCode,
                          double revisedSamplingInterval,
                          org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger revisedQueueSize,
                          org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject filterResult,
                          org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode monitoringMode,
                          org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject monitoringFilter,
                          boolean discardOldest,
                          org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn timestamps)

Method Detail

getClient

public OpcUaClient getClient()

Description copied from interface: UaMonitoredItem

Get the OpcUaClient that created this monitored item.

Specified by:

getClient in interface UaMonitoredItem

Returns:

the OpcUaClient that created this monitored item.

getClientHandle

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getClientHandle()

Description copied from interface: UaMonitoredItem

Get the client-assigned id.

This handle is used in the subscription to match incoming values to the corresponding monitored item.

Specified by:

getClientHandle in interface UaMonitoredItem

Returns:

the client-assigned id.

getReadValueId

public org.eclipse.milo.opcua.stack.core.types.structured.ReadValueId getReadValueId()

Description copied from interface: UaMonitoredItem

Get the ReadValueId.

Specified by:

getReadValueId in interface UaMonitoredItem

Returns:

the ReadValueId.

getMonitoredItemId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMonitoredItemId()

Description copied from interface: UaMonitoredItem

Get the server-assigned id.

Specified by:

getMonitoredItemId in interface UaMonitoredItem

Returns:

the server-assigned id.

getStatusCode

public org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode getStatusCode()

Description copied from interface: UaMonitoredItem

Get the StatusCode of the last operation.

Specified by:

getStatusCode in interface UaMonitoredItem

Returns:

the StatusCode of the last operation.

getRequestedSamplingInterval

public double getRequestedSamplingInterval()

Description copied from interface: UaMonitoredItem

Get the last requested sampling interval.

Specified by:

getRequestedSamplingInterval in interface UaMonitoredItem

Returns:

the last requested sampling interval.

getRevisedSamplingInterval

public double getRevisedSamplingInterval()

Description copied from interface: UaMonitoredItem

Get the revised sampling interval.

Specified by:

getRevisedSamplingInterval in interface UaMonitoredItem

Returns:

the revised sampling interval.

getRequestedQueueSize

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getRequestedQueueSize()

Description copied from interface: UaMonitoredItem

Get the last requested queue size.

Specified by:

getRequestedQueueSize in interface UaMonitoredItem

Returns:

the last requested queue size.

getRevisedQueueSize

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getRevisedQueueSize()

Description copied from interface: UaMonitoredItem

Get the revised queue size.

Specified by:

getRevisedQueueSize in interface UaMonitoredItem

Returns:

the revised queue size.

getFilterResult

public org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject getFilterResult()

Description copied from interface: UaMonitoredItem

Get the filter result ExtensionObject.

Specified by:

getFilterResult in interface UaMonitoredItem

Returns:

the filter result ExtensionObject.

getMonitoringMode

public org.eclipse.milo.opcua.stack.core.types.enumerated.MonitoringMode getMonitoringMode()

Description copied from interface: UaMonitoredItem

Get the MonitoringMode.

Specified by:

getMonitoringMode in interface UaMonitoredItem

Returns:

the MonitoringMode.

getMonitoringFilter

public org.eclipse.milo.opcua.stack.core.types.builtin.ExtensionObject getMonitoringFilter()

Description copied from interface: UaMonitoredItem

Get the filter requested when the item was created.

May be null if no filter was requested.

Specified by:

getMonitoringFilter in interface UaMonitoredItem

Returns:

the filter requested when the item was created. May be null if no filter was requested.

getDiscardOldest

public boolean getDiscardOldest()

Description copied from interface: UaMonitoredItem

Get the discard policy.

true if oldest are discarded when the queue capacity is exceeded.

Specified by:

getDiscardOldest in interface UaMonitoredItem

Returns:

the discard policy.

getTimestamps

public org.eclipse.milo.opcua.stack.core.types.enumerated.TimestampsToReturn getTimestamps()

Description copied from interface: UaMonitoredItem

Get the TimestampsToReturn requested when the item was created.

Specified by:

getTimestamps in interface UaMonitoredItem

Returns:

the TimestampsToReturn requested when the item was created.

setValueConsumer

public void setValueConsumer(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.DataValue> consumer)

Description copied from interface: UaMonitoredItem

Set the Consumer that will receive values as they arrive from the server.

Specified by:

setValueConsumer in interface UaMonitoredItem

Parameters:

consumer - the Consumer that will receive values as they arrive from the server.

setValueConsumer

public void setValueConsumer(UaMonitoredItem.ValueConsumer valueConsumer)

Description copied from interface: UaMonitoredItem

Set a UaMonitoredItem.ValueConsumer that will receive values as they arrive from the server.

The UaMonitoredItem in the consumer will be this item.

Specified by:

setValueConsumer in interface UaMonitoredItem

Parameters:

valueConsumer - the UaMonitoredItem.ValueConsumer that will receive values as they arrive from the server.

setEventConsumer

public void setEventConsumer(Consumer<org.eclipse.milo.opcua.stack.core.types.builtin.Variant[]> consumer)

Description copied from interface: UaMonitoredItem

Set the Consumer that will receive events as they arrive from the server.

Specified by:

setEventConsumer in interface UaMonitoredItem

Parameters:

consumer - the Consumer that will receive events as they arrive from the server.

setEventConsumer

public void setEventConsumer(UaMonitoredItem.EventConsumer eventConsumer)

Description copied from interface: UaMonitoredItem

Set the UaMonitoredItem.EventConsumer that will receive events as they arrive from the server.

Specified by:

setEventConsumer in interface UaMonitoredItem

Parameters:

eventConsumer - the UaMonitoredItem.EventConsumer that will receive events as they arrive from the server.