stella.io

Class PollingBeckhoffServer

java.lang.Object

util.PropertyContainer

io.AbstractDriver

stella.net.ads.AdsSocketChannel

stella.io.PollingBeckhoffServer

All Implemented Interfaces:

Driver, Cloneable, CacheChangedCaster, ExitCleaning, Initializable, Preserving, PropertySupplying, Simulating

public class PollingBeckhoffServer
extends AdsSocketChannel
implements CacheChangedCaster, Initializable, Simulating, Preserving

Author:

wooz

Nested Class Summary

Nested classes/interfaces inherited from class stella.net.ads.AdsSocketChannel

AdsSocketChannel.Close, AdsSocketChannel.Info, AdsSocketChannel.Open

Field Summary

Fields

Modifier and Type	Field and Description
private double	accelerate Accelerate simulation by this factor.
private static long	DEFAVERAGEWRITETIME
private static boolean	DEFPERSITENTHANDLES
private static long	DEFPOLLDELAY The default polling delay of 0 ms.
private static String	DEFPOLLING
private static String	DEFPRERECORDED
private static boolean	DEFSYNCHRONIZED
static String	KEY_AVERAGEWRITETIME If I have no statistical evidence for write times.
static String	KEY_KEEPWRITETIME Save the write number statistic to this file for simulator mode.
static String	KEY_PERSITENTHANDLES If true, handles for variable names are queried only once.
static String	KEY_POLLBASE The key for the basic polling repetition interval, ms.
static String	KEY_POLLDELAY The key for the ms delay of polling start.
static String	KEY_POLLING The list of variables to query.
static String	KEY_PRERECORDED The list of variables to query in simulation mode.
static String	KEY_SYNCHRONIZED If true writing of variables only allow outside of polling
private Map<String,AdsValue>	known The entire set of variables known in the PLC.
private boolean	simulate If true, we are in simulation mode.
private AbstractVariableMonitor	weather The variable polling instance.
private Map<String,Long>	writehandles If handles are persistent, we also cache write handles.
private RudimentaryStats	writetime Statistic on write number times .
private Map<String,Number>	written Keeps written variables in simulation mode.

Fields inherited from class stella.net.ads.AdsSocketChannel

BFALSE, BTRUE, KEY_BLOCKING, KEY_KEEPALIVE, KEY_SOCKETPORT, KEY_SOCKETSERVER, KEY_SOCKETTIMEOUT, KEY_SOURCEAMSID, KEY_SOURCEPORT, KEY_TARGETAMSID, KEY_TARGETPORT

Fields inherited from class io.AbstractDriver

KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
PollingBeckhoffServer(Map<String,String> props)

Method Summary

Modifier and Type	Method and Description
boolean	accelerate(double by) Accelerates the time flow by the stated factor.
void	addCacheChangedListener(CacheChangedListener ear, String key) Adds a listener to this caster.
void	exit()
(package private) Set<String>	getKnownVariables()
(package private) AbstractVariableMonitor	getVariableMonitor()
void	init()
boolean	isKnownVariable(String name)
boolean	open() We open a socket channel to the socket address specified in AdsSocketChannel.KEY_SOCKETSERVER and AdsSocketChannel.KEY_SOCKETPORT.
boolean	preserve() On exit, we save our current state if the serialize property is set.
boolean	readBoolean(String name)
boolean	readBoolean(String name, boolean def)
Number	readNumber(String name)
private Object	readVariable(String name)
void	removeCacheChangedListener(CacheChangedListener ear, String key) Deregisters a listener from this caster.
boolean	restore() We restore our old value by reading the last date and target count from a serialization file.
boolean	startSimulate() A driver can be put into simulation mode only before it has been opened, otherwise an illegal state exception is thrown.
boolean	stopSimulate() Stops the simulation.
private boolean	writeBeckhoff(String name, AdsValue skel, Number value)
boolean	writeNumber(String name, Number value)

Methods inherited from class stella.net.ads.AdsSocketChannel

close, deleteHandleForVariable, deleteHandlesForBlock, deleteHandlesForBlock, ensureConnect, getAllVariables, getDeviceInfo, getHandleForVariable, getHandlesForBlock, getNumericByHandle, getNumericByName, getSourceId, getSourcePort, getStringByHandle, getStringByName, getTargetId, getTargetPort, getValuesByHandleBlock, getValuesByNameBlock, isOpen, writeNumericToHandle, writeNumericToName, writeStringToHandle, writeStringToName, writeValuesByHandleBlock

Methods inherited from class io.AbstractDriver

createDriver, equals, getDriverName, hashCode

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PERSITENTHANDLES

public static final String KEY_PERSITENTHANDLES

If true, handles for variable names are queried only once.

See Also:

Constant Field Values

KEY_SYNCHRONIZED

public static final String KEY_SYNCHRONIZED

If true writing of variables only allow outside of polling

See Also:

Constant Field Values

KEY_POLLDELAY

public static final String KEY_POLLDELAY

The key for the ms delay of polling start.

See Also:

Constant Field Values

KEY_POLLBASE

public static final String KEY_POLLBASE

The key for the basic polling repetition interval, ms.

See Also:

Constant Field Values

KEY_POLLING

public static final String KEY_POLLING

The list of variables to query.

See Also:

Constant Field Values

KEY_PRERECORDED

public static final String KEY_PRERECORDED

The list of variables to query in simulation mode.

See Also:

Constant Field Values

KEY_KEEPWRITETIME

public static final String KEY_KEEPWRITETIME

Save the write number statistic to this file for simulator mode.

See Also:

Constant Field Values

KEY_AVERAGEWRITETIME

public static final String KEY_AVERAGEWRITETIME

If I have no statistical evidence for write times.

See Also:

Constant Field Values

DEFPOLLDELAY

private static final long DEFPOLLDELAY

The default polling delay of 0 ms.

See Also:

Constant Field Values

DEFPERSITENTHANDLES

private static final boolean DEFPERSITENTHANDLES

See Also:

Constant Field Values

DEFSYNCHRONIZED

private static final boolean DEFSYNCHRONIZED

See Also:

Constant Field Values

DEFAVERAGEWRITETIME

private static final long DEFAVERAGEWRITETIME

See Also:

Constant Field Values

DEFPOLLING

private static final String DEFPOLLING

See Also:

Constant Field Values

DEFPRERECORDED

private static final String DEFPRERECORDED

See Also:

Constant Field Values

writehandles

private Map<String,Long> writehandles

If handles are persistent, we also cache write handles.

known

private Map<String,AdsValue> known

The entire set of variables known in the PLC.

weather

private AbstractVariableMonitor weather

The variable polling instance.

writetime

private RudimentaryStats writetime

Statistic on write number times .

simulate

private boolean simulate

If true, we are in simulation mode.

accelerate

private double accelerate

Accelerate simulation by this factor.

written

private Map<String,Number> written

Keeps written variables in simulation mode.

Constructor Detail

PollingBeckhoffServer

public PollingBeckhoffServer(Map<String,String> props)

Parameters:

props -

Method Detail

init

public void init()

Specified by:

init in interface Initializable

Overrides:

init in class AdsSocketChannel

exit

public void exit()

Specified by:

exit in interface ExitCleaning

open

public boolean open()
             throws IOException

Description copied from class: AdsSocketChannel

We open a socket channel to the socket address specified in AdsSocketChannel.KEY_SOCKETSERVER and AdsSocketChannel.KEY_SOCKETPORT. It is not advised to state a socket timeout, but if so, the underlying socket to the channel is manipulated in it SO timeout.

Specified by:

open in interface Driver

Overrides:

open in class AdsSocketChannel

Returns:

True if initialization was successful.

Throws:

IOException

getKnownVariables

Set<String> getKnownVariables()

getVariableMonitor

AbstractVariableMonitor getVariableMonitor()

readVariable

private Object readVariable(String name)

readNumber

public Number readNumber(String name)

readBoolean

public boolean readBoolean(String name)

readBoolean

public boolean readBoolean(String name,
                           boolean def)

isKnownVariable

public boolean isKnownVariable(String name)

writeNumber

public boolean writeNumber(String name,
                           Number value)
                    throws IOException

Throws:

IOException

writeBeckhoff

private boolean writeBeckhoff(String name,
                              AdsValue skel,
                              Number value)
                       throws IOException

Throws:

IOException

addCacheChangedListener

public void addCacheChangedListener(CacheChangedListener ear,
                                    String key)

Description copied from interface: CacheChangedCaster

Adds a listener to this caster. Whenever the cached value mapped to the specified key changes, the listener is notified with a CacheChangedEvent.

Specified by:

addCacheChangedListener in interface CacheChangedCaster

Parameters:

ear - The listener to be notified when the cache value changes.

key - The serial command this listenr is interested in.

removeCacheChangedListener

public void removeCacheChangedListener(CacheChangedListener ear,
                                       String key)

Description copied from interface: CacheChangedCaster

Deregisters a listener from this caster. Only the listening bound to the specified key is released. If the same listener is still listening for other serial commands, these bindings are untouched.

Specified by:

removeCacheChangedListener in interface CacheChangedCaster

Parameters:

ear - The listener to be notified when the cache value changes.

key - The serial command this listenr is interested in.

startSimulate

public boolean startSimulate()

A driver can be put into simulation mode only before it has been opened, otherwise an illegal state exception is thrown.

Specified by:

startSimulate in interface Simulating

stopSimulate

public boolean stopSimulate()

Stops the simulation. If we now continue with program execution and open the driver, it is physically opened. Once opened, it cannot be put into simulation mode again.

Specified by:

stopSimulate in interface Simulating

accelerate

public boolean accelerate(double by)
                   throws UnsupportedOperationException

Accelerates the time flow by the stated factor. For an beckhoff polling server this means that the variable monitor is sped up (i.e. updating its fake-cache faster) and also the communication delay is shortened.

Specified by:

accelerate in interface Simulating

Throws:

UnsupportedOperationException

restore

public boolean restore()

We restore our old value by reading the last date and target count from a serialization file.

Specified by:

restore in interface Preserving

preserve

public boolean preserve()

On exit, we save our current state if the serialize property is set. First the date, then the targetnumber is writtn.

Specified by:

preserve in interface Preserving