Syringe

All Superinterfaces:: Configurable, Device, Findable, gda.observable.IObservable, gda.observable.IObserver

All Known Implementing Classes:: SyringePump

public interface Syringe extends Device, gda.observable.IObserver

Method Summary

Modifier and Type

Method

Description

double

getCapacity()

Get capacity of current syringe.

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

setVolume(double ml)

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

void

stop()

Methods inherited from interface gda.factory.Configurable
configure, 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

Methods inherited from interface gda.observable.IObserver
update

Method Details
- isBusy
  
  boolean isBusy() throws DeviceException
  
  Throws:
  
  DeviceException
- stop
  
  void stop() throws DeviceException
  
  Throws:
  
  DeviceException
- infuse
  
  void infuse(double ml) throws DeviceException
  
  Infuse or withdraw liquid from/to the syringe
  
  Parameters:
  
  ml - volume to infuse
  - positive is infusing (reducing volume remaining in syringe)
  - can be negative (withdrawal)
  
  Throws:
  
  DeviceException
- getVolume
  
  double getVolume() throws DeviceException
  
  Throws:
  
  DeviceException
- getCapacity
  
  double getCapacity()
  
  Get capacity of current syringe. Capacity may also need to be configured in the device hardware.
  
  Returns:
  
  capacity in ml
- getInfuseRate
  
  double getInfuseRate() throws DeviceException
  
  Throws:
  
  DeviceException
- getWithdrawRate
  
  double getWithdrawRate() throws DeviceException
  
  Throws:
  
  DeviceException
- getRemainingTime
  
  double getRemainingTime() throws DeviceException
  
  Get time to infuse current volume at the current infuse rate
  
  Returns:
  
  Time in seconds
  
  Throws:
  
  DeviceException
- setVolume
  
  void setVolume(double ml) throws DeviceException
  
  Set the volume of fluid in the syringe - must be set when syringe is refilled.
  
  Parameters:
  
  ml - current volume
  
  Throws:
  
  DeviceException - if syringe is busy when called
- isEnabled
  
  boolean isEnabled()