com.inductiveautomation.xopc.driver.api

Class AggregateSubscriptionItem

java.lang.Object

com.inductiveautomation.xopc.driver.api.AggregateSubscriptionItem

All Implemented Interfaces:

DriverItem, ReadItem, SubscriptionItem

public class AggregateSubscriptionItem
extends java.lang.Object
implements SubscriptionItem

An AggregateSubscriptionItem aggregates a list of subscription items with the same address. It returns the fastest (lowest) sampling rate, and delegates the setValue() call to all sub-items.

Equality and hash code are finalized as the default Object equals() and hashCode(), meaning an AggregateSubscriptionItem is equal to another AggregateSubscriptionItem if and only if they are the same object.

An AggregateSubscriptionItem should never be kept if empty.

Constructor Summary

Constructors

Constructor and Description
AggregateSubscriptionItem(SubscriptionItem item)

Method Summary

Modifier and Type	Method and Description
void	addItem(SubscriptionItem item)
boolean	equals(java.lang.Object obj)
java.lang.String	getAddress()
java.lang.Object	getAddressObject()
java.util.LinkedList<SubscriptionItem>	getItems()
NodeId	getNodeId()
int	getSamplingRate() The rate (in milliseconds) that the Driver should update this item at.
int	hashCode()
boolean	isEmpty()
boolean	removeItem(SubscriptionItem item)
void	setAddressObject(java.lang.Object obj)
void	setValue(DataValue value) Callback that the driver will invoke when the read completes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AggregateSubscriptionItem

public AggregateSubscriptionItem(SubscriptionItem item)

Method Detail

getNodeId

public NodeId getNodeId()

Specified by:

getNodeId in interface DriverItem

Returns:

The NodeId of the Node this item represents.

getAddress

public java.lang.String getAddress()

Specified by:

getAddress in interface DriverItem

Returns:

The address that identifies this DriverItem.

setValue

public void setValue(DataValue value)

Description copied from interface: ReadItem

Callback that the driver will invoke when the read completes.

Specified by:

setValue in interface ReadItem

Parameters:

value - The DataValue read from the device.

addItem

public void addItem(SubscriptionItem item)

removeItem

public boolean removeItem(SubscriptionItem item)

getItems

public java.util.LinkedList<SubscriptionItem> getItems()

getSamplingRate

public int getSamplingRate()

Description copied from interface: SubscriptionItem

The rate (in milliseconds) that the Driver should update this item at.

Specified by:

getSamplingRate in interface SubscriptionItem

isEmpty

public boolean isEmpty()

getAddressObject

public java.lang.Object getAddressObject()

Specified by:

getAddressObject in interface DriverItem

Returns:

An optional driver-specific object that can hold a parsed version of the address.

setAddressObject

public void setAddressObject(java.lang.Object obj)

Specified by:

setAddressObject in interface DriverItem

Parameters:

obj - The driver-specific address object for this item.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object