Package gda.device.detector.pilatus

Class DummyPilatus

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.pilatus.DummyPilatus

All Implemented Interfaces:

Detector, Pilatus, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable

public class DummyPilatus
extends DetectorBase
implements Pilatus

See Also:

• Serialized Form

Field Summary

Fields inherited from class gda.device.detector.DetectorBase

collectionTime

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, 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.Detector

BUSY, FAULT, IDLE, MONITORING, PAUSED, STANDBY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
DummyPilatus()

Method Summary

Modifier and Type	Method	Description
void	collectData()	Tells the detector to begin to collect a set of data, then returns immediately.
boolean	createsOwnFiles()	Returns a value which indicates whether the detector creates its own files.
double	getCollectionPeriod()
double	getDelayTime()
String	getDescription()
String	getDetectorID()
String	getDetectorType()
int	getFilenumber()
String	getGain()
String[]	getGainLabels()
String	getMode()
String[]	getModeLabels()
int	getStatus()	Returns the current collecting state of the device.
double	getThresholdEnergy()
Object	readout()	Returns the latest data collected.
void	sendGeneralText()
void	setCollectionPeriod(double t)
void	setDelayTime(double delaySec)
void	setFileformat(String fileformat)
void	setFileHeader(String fileHeader)
void	setFilename(String filename)
void	setFilenumber(int n)
void	setFilepath(String filepath)
void	setGain(String gainName)
void	setGeneralText(String toSend)
void	setMode(String modeName)
void	setNumberImages(int n)
void	setThresholdEnergy(double energyValue)
void	updateFilenumber()

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getPosition, isBusy, prepareForCollection, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

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

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.Detector

endCollection, getCollectionTime, getDataDimensions, getFileStructure, prepareForCollection, setCollectionTime, waitWhileBusy

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.device.Scannable

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, toFormattedString

Constructor Details

DummyPilatus

public DummyPilatus()

Method Details

collectData

public void collectData()
                 throws DeviceException

Description copied from interface: Detector

Tells the detector to begin to collect a set of data, then returns immediately. Should cause the hardware to start collecting immediately: if there is any delay then detectors used in the same scan would collect over different times when beam conditions may differ.

Specified by:

collectData in interface Detector

Throws:

DeviceException

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: Detector

Returns the current collecting state of the device.

Specified by:

getStatus in interface Detector

Returns:

BUSY if the detector has not finished the requested operation(s), IDLE if in an completely idle state and STANDBY if temporarily suspended.

Throws:

DeviceException

readout

public Object readout()
               throws DeviceException

Description copied from interface: Detector

Returns the latest data collected. The size of the Object returned must be consistent with the values returned by getDataDimensions and getExtraNames.

If LocalProperties.GDA_SCAN_CONCURRENTSCAN_READOUT_CONCURRENTLY is true then motors may be moved while the detector readouts. The value returned must not be effected by any concurrent motor or shutter movements. See Detector.waitWhileBusy() and ConcurrentScan. Readout must block until the detector is ready to respond quickly to Detector.collectData() again.

Specified by:

readout in interface Detector

Returns:

the data collected

Throws:

DeviceException

createsOwnFiles

public boolean createsOwnFiles()
                        throws DeviceException

Description copied from interface: Detector

Returns a value which indicates whether the detector creates its own files. If it does (return true) the readout() method returns the name of the latest file created as a string. If it does not (return false) the readout() method will return the data directly.

Specified by:

createsOwnFiles in interface Detector

Returns:

true if readout() returns filenames

Throws:

DeviceException

getDescription

public String getDescription()
                      throws DeviceException

Specified by:

getDescription in interface Detector

Overrides:

getDescription in class DetectorBase

Returns:

A description of the detector.

Throws:

DeviceException

getDetectorID

public String getDetectorID()
                     throws DeviceException

Specified by:

getDetectorID in interface Detector

Overrides:

getDetectorID in class DetectorBase

Returns:

A identifier for this detector.

Throws:

DeviceException

getDetectorType

public String getDetectorType()
                       throws DeviceException

Specified by:

getDetectorType in interface Detector

Overrides:

getDetectorType in class DetectorBase

Returns:

The type of detector.

Throws:

DeviceException

setCollectionPeriod

public void setCollectionPeriod(double t)

Specified by:

setCollectionPeriod in interface Pilatus

getCollectionPeriod

public double getCollectionPeriod()

Specified by:

getCollectionPeriod in interface Pilatus

setMode

public void setMode(String modeName)
             throws DeviceException

Specified by:

setMode in interface Pilatus

Throws:

DeviceException

setGain

public void setGain(String gainName)
             throws DeviceException

Specified by:

setGain in interface Pilatus

Throws:

DeviceException

getMode

public String getMode()
               throws DeviceException

Specified by:

getMode in interface Pilatus

Throws:

DeviceException

getGain

public String getGain()
               throws DeviceException

Specified by:

getGain in interface Pilatus

Throws:

DeviceException

getModeLabels

public String[] getModeLabels()
                       throws DeviceException

Specified by:

getModeLabels in interface Pilatus

Throws:

DeviceException

getGainLabels

public String[] getGainLabels()
                       throws DeviceException

Specified by:

getGainLabels in interface Pilatus

Throws:

DeviceException

setFilename

public void setFilename(String filename)
                 throws DeviceException

Specified by:

setFilename in interface Pilatus

Throws:

DeviceException

setFileformat

public void setFileformat(String fileformat)
                   throws DeviceException

Specified by:

setFileformat in interface Pilatus

Throws:

DeviceException

setFileHeader

public void setFileHeader(String fileHeader)
                   throws DeviceException

Specified by:

setFileHeader in interface Pilatus

Throws:

DeviceException

setFilepath

public void setFilepath(String filepath)
                 throws DeviceException

Specified by:

setFilepath in interface Pilatus

Throws:

DeviceException

setFilenumber

public void setFilenumber(int n)
                   throws DeviceException

Specified by:

setFilenumber in interface Pilatus

Throws:

DeviceException

getFilenumber

public int getFilenumber()
                  throws DeviceException

Specified by:

getFilenumber in interface Pilatus

Throws:

DeviceException

updateFilenumber

public void updateFilenumber()
                      throws DeviceException

Specified by:

updateFilenumber in interface Pilatus

Throws:

DeviceException

setNumberImages

public void setNumberImages(int n)
                     throws DeviceException

Specified by:

setNumberImages in interface Pilatus

Throws:

DeviceException

getThresholdEnergy

public double getThresholdEnergy()
                          throws DeviceException

Specified by:

getThresholdEnergy in interface Pilatus

Throws:

DeviceException

setThresholdEnergy

public void setThresholdEnergy(double energyValue)
                        throws DeviceException

Specified by:

setThresholdEnergy in interface Pilatus

Throws:

DeviceException

setDelayTime

public void setDelayTime(double delaySec)
                  throws DeviceException

Specified by:

setDelayTime in interface Pilatus

Throws:

DeviceException

getDelayTime

public double getDelayTime()
                    throws DeviceException

Specified by:

getDelayTime in interface Pilatus

Throws:

DeviceException

setGeneralText

public void setGeneralText(String toSend)

Specified by:

setGeneralText in interface Pilatus

sendGeneralText

public void sendGeneralText()

Specified by:

sendGeneralText in interface Pilatus