io

Class AbstractDriver

java.lang.Object

util.PropertyContainer

io.AbstractDriver

All Implemented Interfaces:

Driver, Cloneable, Initializable, PropertySupplying

Direct Known Subclasses:

AbstractCcdDriver, AbstractPilarDriver, AbstractSerialDriver, AbstractSimulatingDriver, AbstractSocketDriver, AdsSocketChannel, BaaderDome, PythonClient, UpsDriver

public abstract class AbstractDriver
extends PropertyContainer
implements Driver

An abstract implementation of a Driver. Provides support for recording of command execution times during normal action. These recorded time may then, in turn, be used in Simulating mode to query average command execution times for simple waits. If the device additionally implements the Preserving interface, it may store the actual command-to-timing look-up table with a call to #preserveCommandTimes and #restoreCommandTimes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DRIVERNAME The name of this driver if explicedly set.

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDriver(Map<String,String> info) Constructs a new driver.

Method Summary

Modifier and Type	Method and Description
static Driver	createDriver(Map<String,String> prop) Creates a new driver instance using the class key found in the properties.
boolean	equals(Object driver) Two drivers are equal if their class is equal and their names match
String	getDriverName() All drivers should provide a property named KEY_DRIVERNAME.
int	hashCode() Hashin is done with the driver name.

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, isOpen, open

Methods inherited from interface util.Initializable

init

Field Detail

KEY_DRIVERNAME

public static final String KEY_DRIVERNAME

The name of this driver if explicedly set.

See Also:

Constant Field Values

Constructor Detail

AbstractDriver

protected AbstractDriver(Map<String,String> info)

Constructs a new driver. Use of this constructor ensures that the PropertySupplying.KEY_CLASS property is always set.

Method Detail

getDriverName

public String getDriverName()

All drivers should provide a property named KEY_DRIVERNAME. If it is not set, we return the class name here.

Specified by:

getDriverName in interface Driver

equals

public boolean equals(Object driver)

Two drivers are equal if their class is equal and their names match

Overrides:

equals in class Object

hashCode

public int hashCode()

Hashin is done with the driver name.

Overrides:

hashCode in class Object

createDriver

public static final Driver createDriver(Map<String,String> prop)

Creates a new driver instance using the class key found in the properties. If the PropertySupplying.KEY_CLASS property is defined, a new driver with the stated class name is created, the supplied properties used as an argument in the constructor.