Package gda.px.detector

Class DetectorProxy

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.px.detector.DetectorProxy

All Implemented Interfaces:

Device, Stoppable, Configurable, Findable, gda.observable.IObservable, Detector

@ServiceInterface(Detector.class)
public class DetectorProxy
extends FindableConfigurableBase
implements Detector

Constructor Summary

Constructors

Constructor	Description
DetectorProxy()

Method Summary

Modifier and Type	Method	Description
void	abort()	Aborts the current action by the detector.
void	addIObserver(gda.observable.IObserver observer)
void	close()	Close and unconfigure the device.
void	deleteIObserver(gda.observable.IObserver observer)
void	deleteIObservers()
void	disableRoiMode()
void	enableRoiMode()
Object	getAttribute(String attributeName)	Get the value of the specified attribute
AutoRunNumberUtils	getAutoRunNumberUtils()
Detector	getDetector()
DetectorStatus	getDetectorStatus()	Returns current status of detector
DetectorDimension	getDimensionInMm()
DetectorDimension	getFullDimensionInMm()
int	getFullSizeX()
int	getFullSizeY()
int	getId()
double	getImageMB()	Returns the size of images produced, in MB
String	getLastImageName()	Returns the filename of the last image created.
double	getMaxDimension()	Returns the largest dimension of the detector face in mm.
double	getMaxFullDimension()
double	getMinExposureTime()
double	getMinStillExposureTime()
int	getProtectionLevel()
int	getSizeX()
int	getSizeY()
String	getSuffix()	Returns the suffix currently given to all images created
String	getTypeString()	Returns the type of the detector
boolean	hasDetector()
void	initialiseDataSet(DetectorCollectionParameters datasetParameters)	Informs the detector that a collection of images with incremental names will be created.
boolean	isBusy()
boolean	isConfigureAtStartup()	Indicates whether this object should be configured at startup.
boolean	isInRoiMode()
void	reconfigure()	Re-initialisation of values and states.
void	setAttribute(String attributeName, Object value)	Set any attribute the implementing classes may provide
void	setConfigureAtStartup(boolean doConfigureAtStartup)
void	setDetector(Detector detector)
void	setProtectionLevel(int newLevel)	Sets the permission level for this object.
void	start(String file, double omegaStart)	Start data collection
void	stop()	Stops the current operation.
void	waitForReady()	Returns when the detector has finished its currently operation.

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigured, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Configurable

configure, isConfigured

Methods inherited from interface gda.factory.Findable

getName, setName

Constructor Details

DetectorProxy

public DetectorProxy()

Method Details

isConfigureAtStartup

public boolean isConfigureAtStartup()

Description copied from interface: Configurable

Indicates whether this object should be configured at startup.

Moved from ConditionallyConfigurable which has been deleted

Specified by:

isConfigureAtStartup in interface Configurable

Overrides:

isConfigureAtStartup in class ConfigurableBase

setConfigureAtStartup

public void setConfigureAtStartup(boolean doConfigureAtStartup)

getDetector

public Detector getDetector()
                     throws IllegalStateException

Throws:

IllegalStateException

hasDetector

public boolean hasDetector()

setDetector

public void setDetector(Detector detector)

setAttribute

public void setAttribute(String attributeName,
 Object value)
                  throws DeviceException

Description copied from interface: Device

Set any attribute the implementing classes may provide

Specified by:

setAttribute in interface Device

Parameters:

attributeName - is the name of the attribute

value - is the value of the attribute

Throws:

DeviceException - if an attribute cannot be set

getAttribute

public Object getAttribute(String attributeName)
                    throws DeviceException

Description copied from interface: Device

Get the value of the specified attribute

Specified by:

getAttribute in interface Device

Parameters:

attributeName - is the name of the attribute

Returns:

the value of the attribute as an Object type

Throws:

DeviceException - if an attribute cannot be retrieved

close

public void close()
           throws DeviceException

Description copied from interface: Device

Close and unconfigure the device.

Specified by:

close in interface Device

Throws:

DeviceException

setProtectionLevel

public void setProtectionLevel(int newLevel)

Description copied from interface: Device

Sets the permission level for this object. If this is not set then a default value will be applied.

Specified by:

setProtectionLevel in interface Device

Parameters:

newLevel -

getProtectionLevel

public int getProtectionLevel()

Specified by:

getProtectionLevel in interface Device

Returns:

int - the permission level for this object.

addIObserver

public void addIObserver(gda.observable.IObserver observer)

Specified by:

addIObserver in interface gda.observable.IObservable

deleteIObserver

public void deleteIObserver(gda.observable.IObserver observer)

Specified by:

deleteIObserver in interface gda.observable.IObservable

deleteIObservers

public void deleteIObservers()

Specified by:

deleteIObservers in interface gda.observable.IObservable

abort

public void abort()
           throws DeviceException

Description copied from interface: Detector

Aborts the current action by the detector. The detector should be left in a state such that data collection can continue without further resetting. This method should also work when the detector is idle.

Specified by:

abort in interface Detector

Throws:

DeviceException

getDetectorStatus

public DetectorStatus getDetectorStatus()
                                 throws DeviceException

Description copied from interface: Detector

Returns current status of detector

Specified by:

getDetectorStatus in interface Detector

Returns:

DetectorStatus

Throws:

DeviceException

getImageMB

public double getImageMB()
                  throws DeviceException

Description copied from interface: Detector

Returns the size of images produced, in MB

Specified by:

getImageMB in interface Detector

Returns:

double

Throws:

DeviceException

getLastImageName

public String getLastImageName()
                        throws DeviceException

Description copied from interface: Detector

Returns the filename of the last image created.

Specified by:

getLastImageName in interface Detector

Returns:

String

Throws:

DeviceException

getSizeX

public int getSizeX()

Specified by:

getSizeX in interface Detector

Returns:

horizontal size of image, in pixels

getSizeY

public int getSizeY()

Specified by:

getSizeY in interface Detector

Returns:

vertical size of image, in pixels

getMaxDimension

public double getMaxDimension()
                       throws DeviceException

Description copied from interface: Detector

Returns the largest dimension of the detector face in mm.

Specified by:

getMaxDimension in interface Detector

Returns:

double

Throws:

DeviceException

getSuffix

public String getSuffix()
                 throws DeviceException

Description copied from interface: Detector

Returns the suffix currently given to all images created

Specified by:

getSuffix in interface Detector

Returns:

String

Throws:

DeviceException

getTypeString

public String getTypeString()

Description copied from interface: Detector

Returns the type of the detector

Specified by:

getTypeString in interface Detector

Returns:

String

initialiseDataSet

public void initialiseDataSet(DetectorCollectionParameters datasetParameters)
                       throws DeviceException

Description copied from interface: Detector

Informs the detector that a collection of images with incremental names will be created. This is not simply called setCurrentParameters to show that this method may often do more work than simply changing an instance field.

Specified by:

initialiseDataSet in interface Detector

Parameters:

datasetParameters -

Throws:

DeviceException

start

public void start(String file,
 double omegaStart)
           throws DeviceException

Description copied from interface: Detector

Start data collection

Specified by:

start in interface Detector

Parameters:

file - - the name of the file to create

omegaStart - - the starting angle of data collection (to go into image header)

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from interface: Stoppable

Stops the current operation.

Specified by:

stop in interface Stoppable

Throws:

DeviceException

waitForReady

public void waitForReady()
                  throws DeviceException

Description copied from interface: Detector

Returns when the detector has finished its currently operation. If its idle then returns immediately.

Specified by:

waitForReady in interface Detector

Throws:

DeviceException

getDimensionInMm

public DetectorDimension getDimensionInMm()

Specified by:

getDimensionInMm in interface Detector

isBusy

public boolean isBusy()
               throws DeviceException

Specified by:

isBusy in interface Detector

Throws:

DeviceException

enableRoiMode

public void enableRoiMode()
                   throws DeviceException

Specified by:

enableRoiMode in interface Detector

Throws:

DeviceException

disableRoiMode

public void disableRoiMode()
                    throws DeviceException

Specified by:

disableRoiMode in interface Detector

Throws:

DeviceException

isInRoiMode

public boolean isInRoiMode()
                    throws DeviceException

Specified by:

isInRoiMode in interface Detector

Throws:

DeviceException

getFullSizeX

public int getFullSizeX()

Specified by:

getFullSizeX in interface Detector

getFullSizeY

public int getFullSizeY()

Specified by:

getFullSizeY in interface Detector

getFullDimensionInMm

public DetectorDimension getFullDimensionInMm()

Specified by:

getFullDimensionInMm in interface Detector

getMaxFullDimension

public double getMaxFullDimension()

Specified by:

getMaxFullDimension in interface Detector

reconfigure

public void reconfigure()
                 throws FactoryException

Description copied from interface: Configurable

Re-initialisation of values and states.

Moved from Reconfigurable which has been deleted

Specified by:

reconfigure in interface Configurable

Overrides:

reconfigure in class ConfigurableBase

Throws:

FactoryException

getAutoRunNumberUtils

public AutoRunNumberUtils getAutoRunNumberUtils()
                                         throws DeviceException

Specified by:

getAutoRunNumberUtils in interface Detector

Throws:

DeviceException

getId

public int getId()

Specified by:

getId in interface Detector

getMinExposureTime

public double getMinExposureTime()

Specified by:

getMinExposureTime in interface Detector

getMinStillExposureTime

public double getMinStillExposureTime()

Specified by:

getMinStillExposureTime in interface Detector