Package uk.ac.gda.devices.pressurecell

Class PressureCell

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

uk.ac.gda.devices.pressurecell.PressureCell

All Implemented Interfaces:

Device, Scannable, Configurable, Findable, gda.observable.IObservable

public class PressureCell
extends ScannableBase

Scannable interface to the pressure cell allowing it to be used in step scans.
Access to lower level controls are available via the controller instance from the getController() method.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	__doc__

Fields inherited from class gda.device.scannable.ScannableBase

DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
PressureCell()

Method Summary

Modifier and Type	Method	Description
void	armJumpValve()
PressureCellController	getController()
uk.ac.gda.devices.pressurecell.data.PressureCellDataController	getDataController()
String	getLastFileName()
boolean	isBusy()	Check if the Scannable is moving/operating.
void	rawAsynchronousMoveTo(Object position)	[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.
Object	rawGetPosition()	[Consider abstract] Read the position in its internal (user) representation.
void	setAcquire(boolean acquiring)
void	setController(PressureCellController controller)
void	setDataController(uk.ac.gda.devices.pressurecell.data.PressureCellDataController dataController)
void	setFilePath(String directory, String filename)
void	setJumpPressures(double from, double to)
void	setSamples(int before, int after)
void	waitWhileBusy()	Returns when operation carried out by moveTo has completed
void	waitWhileBusy(double timeoutInSeconds)	Its like waitWhileBusy, has a timeout and will throws a DeviceException if the time limit is reached.

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toFormattedString, toString, validateScannable, valueUnavailableString

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

configure, 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

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

Field Details

__doc__

public static final String __doc__

See Also:

• Constant Field Values

Constructor Details

PressureCell

public PressureCell()

Method Details

setFilePath

public void setFilePath(String directory,
 String filename)
                 throws DeviceException

Throws:

DeviceException

setAcquire

public void setAcquire(boolean acquiring)
                throws DeviceException

Throws:

DeviceException

getLastFileName

public String getLastFileName()
                       throws DeviceException

Throws:

DeviceException

setSamples

public void setSamples(int before,
 int after)
                throws DeviceException

Throws:

DeviceException

rawGetPosition

public Object rawGetPosition()
                      throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Read the position in its internal (user) representation.

Overrides:

rawGetPosition in class ScannableBase

Returns:

the value represented by this Scannable

Throws:

DeviceException

See Also:

• Scannable.getPosition()

rawAsynchronousMoveTo

public void rawAsynchronousMoveTo(Object position)
                           throws DeviceException

Description copied from class: ScannableBase

[Consider abstract] Trigger a move/operation to an internal/hardware position and return immediately.

Overrides:

rawAsynchronousMoveTo in class ScannableBase

Parameters:

position - Position in its internal/hardware representation. e.g. with units and offsets removed

Throws:

DeviceException

See Also:

• asynchronousMoveTo

setJumpPressures

public void setJumpPressures(double from,
 double to)
                      throws DeviceException

Throws:

DeviceException

armJumpValve

public void armJumpValve()
                  throws DeviceException

Throws:

DeviceException

getController

public PressureCellController getController()

setController

public void setController(PressureCellController controller)

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Returns:

true - if operation carried out by moveTo has not completed yet

Throws:

DeviceException

waitWhileBusy

public void waitWhileBusy()
                   throws DeviceException,
InterruptedException

Description copied from class: ScannableBase

Returns when operation carried out by moveTo has completed If this is to be overriden, isBusy must also be valid. Although the pos and scan command currently use this method to determine if the Scannable is busy, this must not be relied upon.

Specified by:

waitWhileBusy in interface Scannable

Overrides:

waitWhileBusy in class ScannableBase

Throws:

DeviceException

InterruptedException

waitWhileBusy

public void waitWhileBusy(double timeoutInSeconds)
                   throws DeviceException,
InterruptedException

Its like waitWhileBusy, has a timeout and will throws a DeviceException if the time limit is reached. If timeout invalid input: '<' 0, this will block indefinitely and is equivalent to waitWhileBusy()

Overrides:

waitWhileBusy in class ScannableBase

Parameters:

timeoutInSeconds -

Throws:

DeviceException

InterruptedException

getDataController

public uk.ac.gda.devices.pressurecell.data.PressureCellDataController getDataController()

setDataController

public void setDataController(uk.ac.gda.devices.pressurecell.data.PressureCellDataController dataController)