org.eclipse.scada.da.server.common

Class DataItemCommand

java.lang.Object

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

org.eclipse.scada.da.server.common.DataItemOutput

org.eclipse.scada.da.server.common.DataItemCommand

All Implemented Interfaces:

DataItem

public class DataItemCommand
extends DataItemOutput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataItemCommand.Listener The listener interface

Field Summary

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

listener

Constructor Summary

Constructors

Constructor and Description
DataItemCommand(String id, Executor executor)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(DataItemCommand.Listener listener) Add a new listener which gets called on write requests
Map<String,org.eclipse.scada.core.Variant>	getAttributes()
void	processWrite(org.eclipse.scada.core.Variant value)
void	removeListener(DataItemCommand.Listener listener) Remove a listener from the list
org.eclipse.scada.utils.concurrent.NotifyFuture<WriteAttributeResults>	startSetAttributes(Map<String,org.eclipse.scada.core.Variant> attributes, OperationParameters operationParameters) Start the write attributes operation
org.eclipse.scada.utils.concurrent.NotifyFuture<WriteResult>	startWriteValue(org.eclipse.scada.core.Variant value, OperationParameters operationParameters) The write operation of a data item.

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

readValue

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

getCacheAttributes, getCacheValue, 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

DataItemCommand

public DataItemCommand(String id,
               Executor executor)

Method Detail

startWriteValue

public org.eclipse.scada.utils.concurrent.NotifyFuture<WriteResult> startWriteValue(org.eclipse.scada.core.Variant value,
                                                                           OperationParameters operationParameters)

Description copied from interface: DataItem

The write operation of a data item.

Parameters:

value - The value to write to the subsystem

Returns:

the future to the operation

processWrite

public void processWrite(org.eclipse.scada.core.Variant value)
                  throws org.eclipse.scada.core.InvalidOperationException

Throws:

org.eclipse.scada.core.InvalidOperationException

addListener

public void addListener(DataItemCommand.Listener listener)

Add a new listener which gets called on write requests

Parameters:

listener - listener to add

removeListener

public void removeListener(DataItemCommand.Listener listener)

Remove a listener from the list

Parameters:

listener - listener to remove

getAttributes

public Map<String,org.eclipse.scada.core.Variant> getAttributes()

startSetAttributes

public org.eclipse.scada.utils.concurrent.NotifyFuture<WriteAttributeResults> startSetAttributes(Map<String,org.eclipse.scada.core.Variant> attributes,
                                                                                        OperationParameters operationParameters)

Description copied from interface: DataItem

Start the write attributes operation

Parameters:

attributes - attributes to set

Returns:

the future to the operation