Package gda.device.syringepump

Class SyringePump

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.syringepump.SyringePump

All Implemented Interfaces:

Device, Syringe, Configurable, Findable, gda.observable.IObservable, gda.observable.IObserver

@ServiceInterface(Syringe.class)
public class SyringePump
extends DeviceBase
implements Syringe

Field Summary

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
SyringePump()

Method Summary

Modifier and Type	Method	Description
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
double	getCapacity()	Get capacity of current syringe.
SyringePumpController	getController()
double	getInfuseRate()
double	getRemainingTime()	Get time to infuse current volume at the current infuse rate
double	getVolume()
double	getWithdrawRate()
void	infuse(double ml)	Infuse or withdraw liquid from/to the syringe
boolean	isBusy()
boolean	isEnabled()
void	setController(SyringePumpController controller)
void	setVolume(double ml)	Set the volume of fluid in the syringe - must be set when syringe is refilled.
void	stop()
String	toString()
void	update(Object source, Object arg)

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Constructor Details

SyringePump

public SyringePump()

Method Details

isBusy

public boolean isBusy()
               throws DeviceException

Specified by:

isBusy in interface Syringe

Throws:

DeviceException

setController

public void setController(SyringePumpController controller)

getController

public SyringePumpController getController()

stop

public void stop()
          throws DeviceException

Specified by:

stop in interface Syringe

Throws:

DeviceException

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

infuse

public void infuse(double ml)
            throws DeviceException

Description copied from interface: Syringe

Infuse or withdraw liquid from/to the syringe

Specified by:

infuse in interface Syringe

Parameters:

ml - volume to infuse
- positive is infusing (reducing volume remaining in syringe)
- can be negative (withdrawal)

Throws:

DeviceException

getVolume

public double getVolume()
                 throws DeviceException

Specified by:

getVolume in interface Syringe

Throws:

DeviceException

getCapacity

public double getCapacity()

Description copied from interface: Syringe

Get capacity of current syringe. Capacity may also need to be configured in the device hardware.

Specified by:

getCapacity in interface Syringe

Returns:

capacity in ml

getRemainingTime

public double getRemainingTime()
                        throws DeviceException

Description copied from interface: Syringe

Get time to infuse current volume at the current infuse rate

Specified by:

getRemainingTime in interface Syringe

Returns:

Time in seconds

Throws:

DeviceException

toString

public String toString()

Overrides:

toString in class Object

setVolume

public void setVolume(double ml)
               throws DeviceException

Description copied from interface: Syringe

Set the volume of fluid in the syringe - must be set when syringe is refilled.

Specified by:

setVolume in interface Syringe

Parameters:

ml - current volume

Throws:

DeviceException - if syringe is busy when called

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Syringe

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getInfuseRate

public double getInfuseRate()
                     throws DeviceException

Specified by:

getInfuseRate in interface Syringe

Throws:

DeviceException

getWithdrawRate

public double getWithdrawRate()
                       throws DeviceException

Specified by:

getWithdrawRate in interface Syringe

Throws:

DeviceException