org.eclipse.neoscada.protocol.iec60870.server.data.model

Class ChangeDataModel

java.lang.Object

org.eclipse.neoscada.protocol.iec60870.server.data.AbstractBaseDataModel

org.eclipse.neoscada.protocol.iec60870.server.data.model.ChangeDataModel

All Implemented Interfaces:

DataModel

Direct Known Subclasses:

DataModelImpl, MockChangeDataModel

public abstract class ChangeDataModel
extends AbstractBaseDataModel

Field Summary

Fields inherited from class org.eclipse.neoscada.protocol.iec60870.server.data.AbstractBaseDataModel

executor

Constructor Summary

Constructors

Constructor and Description
ChangeDataModel(String threadName)

Method Summary

Modifier and Type	Method and Description
BackgroundIterator	createBackgroundIterator() Create a new background iterator If the implementation does not support background transmissions, null may be returned.
protected abstract BackgroundModel	createBackgroundModel() Create a BackgroundModel for this data model instance
protected abstract ChangeModel	createChangeModel() Create a ChangeModel for this data model instance
protected abstract WriteModel	createWriteModel() Create a WriteModel for this data model instance
void	forAllAsdu(Consumer<ASDUAddress> function, Runnable ifNoneFound) A method that will call the provided function for each known ASDU address
protected ChangeModel	makeBufferingChangeModel(long flushDelay)
protected BackgroundModel	makeDefaultBackgroundModel()
protected ChangeModel	makeInstantChangeModel()
protected void	notifyDataChange(ASDUAddress asduAddress, InformationObjectAddress informationObjectAddress, Value<?> value, boolean notify)
protected void	performForAllAsdu(Consumer<ASDUAddress> function, Runnable ifNoneFound)
protected Value<?>	performRead(ASDUAddress asduAddress, InformationObjectAddress address)
protected void	performReadAll(ASDUAddress asduAddress, DataListener listener, Map<Integer,Value<?>> map)
com.google.common.util.concurrent.ListenableFuture<Value<?>>	read(ASDUAddress asduAddress, InformationObjectAddress address) Read a specific value The future will be called with the result of the read operation.
com.google.common.util.concurrent.ListenableFuture<Void>	readAll(ASDUAddress asduAddress, Runnable prepare, DataListener listener) Read all values from the internal structures The data will not be returned by the future, but pushed to the DataListener.
void	start()
Stopping	stop()
void	writeCommand(ASDUHeader header, InformationObjectAddress informationObjectAddress, boolean state, byte type, MirrorCommand mirrorCommand, boolean execute)
void	writeFloatValue(ASDUHeader header, InformationObjectAddress informationObjectAddress, float value, byte type, MirrorCommand mirrorCommand, boolean execute)
void	writeScaledValue(ASDUHeader header, InformationObjectAddress informationObjectAddress, short value, byte type, MirrorCommand mirrorCommand, boolean execute)

Methods inherited from class org.eclipse.neoscada.protocol.iec60870.server.data.AbstractBaseDataModel

disposeSubscription, getNumberOfSubscriptions, notifyChangeBoolean, notifyChangeBoolean, notifyChangeFloat, notifyChangeFloat, notifyChangeShort, notifyChangeShort, subscribe

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.neoscada.protocol.iec60870.server.data.DataModel

forAllAsdu

Constructor Detail

ChangeDataModel

public ChangeDataModel(String threadName)

Method Detail

createChangeModel

protected abstract ChangeModel createChangeModel()

Create a ChangeModel for this data model instance

This method is called exactly once by the start() method

Returns:

a new change model instance

createWriteModel

protected abstract WriteModel createWriteModel()

Create a WriteModel for this data model instance

This method is called exactly once by the start() method

Returns:

a new write model instance

createBackgroundModel

protected abstract BackgroundModel createBackgroundModel()

Create a BackgroundModel for this data model instance

This method is called exactly once by the start() method

Returns:

a new background model instance

start

public void start()

Specified by:

start in interface DataModel

Overrides:

start in class AbstractBaseDataModel

stop

public Stopping stop()

Specified by:

stop in interface DataModel

Overrides:

stop in class AbstractBaseDataModel

makeDefaultBackgroundModel

protected BackgroundModel makeDefaultBackgroundModel()

makeInstantChangeModel

protected ChangeModel makeInstantChangeModel()

makeBufferingChangeModel

protected ChangeModel makeBufferingChangeModel(long flushDelay)

createBackgroundIterator

public BackgroundIterator createBackgroundIterator()

Description copied from interface: DataModel

Create a new background iterator
If the implementation does not support background transmissions, null may be returned.
The background iterator instance must not cache values. As this would cause a situation where more up-to-date values would get overwritten by the cached values of the background iterator.

Returns:

the new background iterator or null

notifyDataChange

protected void notifyDataChange(ASDUAddress asduAddress,
                                InformationObjectAddress informationObjectAddress,
                                Value<?> value,
                                boolean notify)

writeCommand

public void writeCommand(ASDUHeader header,
                         InformationObjectAddress informationObjectAddress,
                         boolean state,
                         byte type,
                         MirrorCommand mirrorCommand,
                         boolean execute)

writeFloatValue

public void writeFloatValue(ASDUHeader header,
                            InformationObjectAddress informationObjectAddress,
                            float value,
                            byte type,
                            MirrorCommand mirrorCommand,
                            boolean execute)

writeScaledValue

public void writeScaledValue(ASDUHeader header,
                             InformationObjectAddress informationObjectAddress,
                             short value,
                             byte type,
                             MirrorCommand mirrorCommand,
                             boolean execute)

read

public com.google.common.util.concurrent.ListenableFuture<Value<?>> read(ASDUAddress asduAddress,
                                                                         InformationObjectAddress address)

Description copied from interface: DataModel

Read a specific value
The future will be called with the result of the read operation. If the value is unknown the future must be called with null.

address - the address to read

Returns:

a listener to the operation, null if the data model instantly decide that the value cannot be read

performRead

protected Value<?> performRead(ASDUAddress asduAddress,
                               InformationObjectAddress address)

readAll

public com.google.common.util.concurrent.ListenableFuture<Void> readAll(ASDUAddress asduAddress,
                                                                        Runnable prepare,
                                                                        DataListener listener)

Description copied from interface: DataModel

Read all values from the internal structures
The data will not be returned by the future, but pushed to the DataListener.

Parameters:

asduAddress - the ASDU common address

prepare - a runnable that will be called before the actual processing, from the same thread the listener will be called. But only when the request actually can be processed. If the runnable was called, the method must not return null.

listener - the data receiver

Returns:

the future which indicates the end of the transmission. This can be null if the ASDU address was unknown.

performReadAll

protected void performReadAll(ASDUAddress asduAddress,
                              DataListener listener,
                              Map<Integer,Value<?>> map)

forAllAsdu

public void forAllAsdu(Consumer<ASDUAddress> function,
                       Runnable ifNoneFound)

Description copied from interface: DataModel

A method that will call the provided function for each known ASDU address

Note that the ASDUs must not change until each function call has been completed.

The function call can be performed asynchronously.

Parameters:

function - the function to call for each known ASDU address

ifNoneFound - will be called if there are no known common ASDU addresses, may be null

performForAllAsdu

protected void performForAllAsdu(Consumer<ASDUAddress> function,
                                 Runnable ifNoneFound)