org.eclipse.scada.da.server.common

Class DataItemInputCommon

java.lang.Object

org.eclipse.scada.da.server.common.DataItemBase

org.eclipse.scada.da.server.common.DataItemInput

org.eclipse.scada.da.server.common.DataItemInputCommon

All Implemented Interfaces:

DataItem

Direct Known Subclasses:

ScheduledDataItem, ScheduledDataItem, StockQuoteItem, SuspendItem

public class DataItemInputCommon
extends DataItemInput

Field Summary

Fields inherited from class org.eclipse.scada.da.server.common.DataItemBase

listener

Constructor Summary

Constructors

Constructor and Description
DataItemInputCommon(DataItemInformation info)
DataItemInputCommon(String name)

Method Summary

Modifier and Type	Method and Description
Map<String,Variant>	getAttributes()
protected Map<String,Variant>	getCacheAttributes()
protected Variant	getCacheValue()
NotifyFuture<Variant>	readValue() The read operation of a data item.
NotifyFuture<WriteAttributeResults>	startSetAttributes(Map<String,Variant> attributes, OperationParameters operationParameters) Perform requests from the hive to update the items attributes This method actually.
void	updateData(Variant value, Map<String,Variant> attributes, AttributeMode mode) Update the value of this data item

Methods inherited from class org.eclipse.scada.da.server.common.DataItemInput

startWriteValue

Methods inherited from class org.eclipse.scada.da.server.common.DataItemBase

getInformation, handleListenerChange, notifyData, notifyData, setListener

Methods inherited from class java.lang.Object

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

Constructor Detail

DataItemInputCommon

public DataItemInputCommon(DataItemInformation info)

DataItemInputCommon

public DataItemInputCommon(String name)

Method Detail

readValue

public NotifyFuture<Variant> readValue()
                                throws InvalidOperationException

Description copied from interface: DataItem

The read operation of a data item.

Returns:

The value read from the subsystem.

Throws:

InvalidOperationException - Raised if "read" is not a valid operation for this item

getAttributes

public Map<String,Variant> getAttributes()

startSetAttributes

public NotifyFuture<WriteAttributeResults> startSetAttributes(Map<String,Variant> attributes,
                                                              OperationParameters operationParameters)

Perform requests from the hive to update the items attributes
This method actually. Reacting to attribute set requests is implementation dependent. So you will need to subclass from DataItemInputCommon and override this method.
If you simple need a memory container that simply stores what you write into it consider using the MemoryDataItem.
If you are implementing a data item based on this item and wish to change the data items attributes use #getAttributeManager() to get the attribute manager which allows you so tweak the items attributes from the side of the item implementation.

Parameters:

attributes - attributes to set

Returns:

the future to the operation

updateData

public void updateData(Variant value,
                       Map<String,Variant> attributes,
                       AttributeMode mode)

Update the value of this data item

Parameters:

value - the new value

getCacheAttributes

protected Map<String,Variant> getCacheAttributes()

Overrides:

getCacheAttributes in class DataItemBase

getCacheValue

protected Variant getCacheValue()

Overrides:

getCacheValue in class DataItemBase