org.eclipse.scada.da.server.exporter.iec60870

Class DataModelImpl

java.lang.Object

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

org.eclipse.scada.da.server.exporter.iec60870.DataModelImpl

All Implemented Interfaces:

DataModel

public class DataModelImpl
extends AbstractBaseDataModel

An IEC60870-5 data model for Eclipse SCADA

Implementation details

All entries are initialized with DataItemValue.DISCONNECTED in order to populate the caches. This will allow the background transfer to already have data before changes came in. And also prevent the cache structures to change, so the background transmission may hold the iterators.

Field Summary

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

executor

Constructor Summary

Constructors

Constructor and Description
DataModelImpl(HiveSource hiveSource, Set<MappingEntry> entries, Properties hiveProperties, InformationBean info)

Method Summary

Methods

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.
void	dispose()
void	disposeAndWait()
protected com.google.common.util.concurrent.ListenableFuture<Void>	disposeSubscription(DefaultSubscription subscription)
void	forAllAsdu(com.google.common.base.Function<ASDUAddress,Void> function, Runnable ifNoneFound) A method that will call the provided function for each known ASDU address
protected void	handleStateChanged(MappingEntry entry, DataItemValue value, boolean notify)
protected Object	internalBackgroundScan(org.eclipse.scada.da.server.exporter.iec60870.DataModelImpl.BackgroundState state)
protected void	performForAllAsdu(com.google.common.base.Function<ASDUAddress,Void> function, Runnable ifNoneFound)
protected Value<?>	performRead(ASDUAddress asduAddress, InformationObjectAddress address)
protected void	performReadAll(ASDUAddress asduAddress, DataListener listener, Map<Integer,Value<?>> map)
protected boolean	performWrite(org.eclipse.scada.da.server.exporter.iec60870.DataModelImpl.WriteRequest request, MirrorCommand mirrorCommand, boolean execute)
Object	proceedBackgroundScan(org.eclipse.scada.da.server.exporter.iec60870.DataModelImpl.BackgroundState state)
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.
Subscription	subscribe(DataListener listener)
void	writeCommand(ASDUHeader header, InformationObjectAddress informationObjectAddress, boolean state, byte type, MirrorCommand mirrorCommand, boolean execute)
void	writeScaledValue(ASDUHeader header, InformationObjectAddress informationObjectAddress, short value, byte type, MirrorCommand mirrorCommand, boolean execute)
void	writeValue(ASDUHeader header, InformationObjectAddress informationObjectAddress, float value, byte type, MirrorCommand mirrorCommand, boolean execute)

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

getNumberOfSubscriptions, notifyChangeBoolean, notifyChangeFloat

Methods inherited from class java.lang.Object

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

Constructor Detail

DataModelImpl

public DataModelImpl(HiveSource hiveSource,
             Set<MappingEntry> entries,
             Properties hiveProperties,
             InformationBean info)

Method Detail

subscribe

public Subscription subscribe(DataListener listener)

Specified by:

subscribe in interface DataModel

Overrides:

subscribe in class AbstractBaseDataModel

disposeSubscription

protected com.google.common.util.concurrent.ListenableFuture<Void> disposeSubscription(DefaultSubscription subscription)

Overrides:

disposeSubscription in class AbstractBaseDataModel

handleStateChanged

protected void handleStateChanged(MappingEntry entry,
                      DataItemValue value,
                      boolean notify)

dispose

public void dispose()

Specified by:

dispose in interface DataModel

Overrides:

dispose in class AbstractBaseDataModel

disposeAndWait

public void disposeAndWait()
                    throws InterruptedException

Overrides:

disposeAndWait in class AbstractBaseDataModel

Throws:

InterruptedException

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(com.google.common.base.Function<ASDUAddress,Void> 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(com.google.common.base.Function<ASDUAddress,Void> function,
                     Runnable ifNoneFound)

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

proceedBackgroundScan

public Object proceedBackgroundScan(org.eclipse.scada.da.server.exporter.iec60870.DataModelImpl.BackgroundState state)

internalBackgroundScan

protected Object internalBackgroundScan(org.eclipse.scada.da.server.exporter.iec60870.DataModelImpl.BackgroundState state)

writeCommand

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

writeValue

public void writeValue(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)

performWrite

protected boolean performWrite(org.eclipse.scada.da.server.exporter.iec60870.DataModelImpl.WriteRequest request,
                   MirrorCommand mirrorCommand,
                   boolean execute)