stella.mxio

Class GenericMoxaRead

java.lang.Object

util.PropertyContainer

io.AbstractDriver

io.AbstractSimulatingDriver

stella.mxio.GenericMoxa

stella.mxio.GenericMoxaRead

All Implemented Interfaces:

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

Direct Known Subclasses:

MoxaAnalog, MoxaDigital, MoxaTemperature

public abstract class GenericMoxaRead
extends GenericMoxa
implements EthReading

This is an abstract implementation of a moxa driver with the capabilities to open a connection and read it.

Nested Class Summary

Nested classes/interfaces inherited from class stella.mxio.GenericMoxa

GenericMoxa.Mxiolib

Field Summary

Fields

Modifier and Type	Field and Description
private Object	cache The last result used for caching.
private static long	DEFCACHETIME Default cache time of five seconds.
private static boolean	DEFPERSISTENT Default not persistent.
static String	KEY_CACHETIME The life-time of the cache.
static String	KEY_PERSISTENT If true, connection is held open after first open.
private long	last The time of the last read.

Fields inherited from class stella.mxio.GenericMoxa

INVALID, KEY_MOXAIP, KEY_MOXAPASSWORD, KEY_MOXAPORT, KEY_MOXATIMEOUT, LIBSYS

Fields inherited from class io.AbstractSimulatingDriver

KEY_KEEPCOMMANDTIMES

Fields inherited from class io.AbstractDriver

KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface stella.mxio.EthReading

CHANNEL_OUT_OF_RANGE, COIL_TYPE_ERROR, CREATE_MUTEX_FAIL, EIO_CREATING_SOCKET_ERROR, EIO_INIT_SOCKETS_FAIL, EIO_PASSWORD_INCORRECT, EIO_RESPONSE_BAD, EIO_SOCKET_DISCONNECT, EIO_TIME_OUT, FIRMWARE_NOT_SUPPORT, FUNCTION_NOT_SUPPORT, HANDLE_ERROR, ILLEGAL_DATA_ADDRESS, ILLEGAL_DATA_VALUE, ILLEGAL_FUNCTION, INPUT_VALUE_OUT_OF_RANGE, MXIO_OK, OUTPUT_VALUE_OUT_OF_RANGE, PRODUCT_NOT_SUPPORT, PROTOCOL_TYPE_ERROR, REGISTER_TYPE_ERROR, SIO_BAUDRATE_NOT_SUPPORT, SIO_CLEAR_COMM_FAIL, SIO_CLOSE_FAIL, SIO_FLUSH_FILE_BUFFERS_FAIL, SIO_GET_COMM_STATE_FAIL, SIO_OPEN_FAIL, SIO_PURGE_COMM_FAIL, SIO_RESPONSE_BAD, SIO_SET_COMM_STATE_FAIL, SIO_SET_COMM_TIME_OUT_FAIL, SIO_SETUP_COMM_FAIL, SIO_TIME_OUT, SIO_TRANSMISSION_MODE_ERROR, SLAVE_DEVICE_BUSY, SLAVE_DEVICE_FAILURE, SLOT_NOT_EXIST, SLOT_OUT_OF_RANGE

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericMoxaRead(Map<String,String> prop) Creates a new generic moxa driver.

Method Summary

Modifier and Type	Method and Description
protected abstract Number	extractFromCache(Object cache, int nr) This method is called with the lately returned cache value and should extract the appropriate number.
Number	readChannel(int nr) We use a cached value to extract the moxa module's current read value.
protected abstract Object	readMoxa() This method is called if the cache is outdated.

Methods inherited from class stella.mxio.GenericMoxa

close, getError, getHandle, init, isOpen, open, readAnalogIn, readDigitalIn, readDigitalOut, readTemps, writeDigitalOut

Methods inherited from class io.AbstractSimulatingDriver

accelerate, addCommandTime, exit, getAcceleration, getCommandTimeAverage, getCommandTimeRandomSample, getCommandTimeSigma, getSimulationStart, isSimulate, preserve, restore, simulateSince, startSimulate, stopSimulate

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

Methods inherited from interface io.Driver

close, getDriverName, isOpen, open

Methods inherited from interface util.Initializable

init

Field Detail

KEY_CACHETIME

public static final String KEY_CACHETIME

The life-time of the cache.

See Also:

Constant Field Values

KEY_PERSISTENT

public static final String KEY_PERSISTENT

If true, connection is held open after first open.

See Also:

Constant Field Values

DEFCACHETIME

private static final long DEFCACHETIME

Default cache time of five seconds. Should be longer than timeout

See Also:

Constant Field Values

DEFPERSISTENT

private static final boolean DEFPERSISTENT

Default not persistent.

See Also:

Constant Field Values

last

private long last

The time of the last read.

cache

private Object cache

The last result used for caching.

Constructor Detail

GenericMoxaRead

protected GenericMoxaRead(Map<String,String> prop)

Creates a new generic moxa driver.

Method Detail

readMoxa

protected abstract Object readMoxa()
                            throws IOException

This method is called if the cache is outdated. It must return an object that can than be translated to a module-depending Number with extractFromCache(java.lang.Object, int).

Throws:

IOException

extractFromCache

protected abstract Number extractFromCache(Object cache,
                                           int nr)

This method is called with the lately returned cache value and should extract the appropriate number.

readChannel

public Number readChannel(int nr)
                   throws IOException

We use a cached value to extract the moxa module's current read value. If the cache is outdated, we read the entrie module, which serves several sensors simultaneously, and then use this value in the return process.

Specified by:

readChannel in interface EthReading

Throws:

IOException