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 -
Method Summary
Modifier and TypeMethodDescriptionvoidabort()Aborts the current action by the detector.voidaddIObserver(gda.observable.IObserver observer) voidclose()Close and unconfigure the device.voiddeleteIObserver(gda.observable.IObserver observer) voidvoidvoidgetAttribute(String attributeName) Get the value of the specified attributeReturns current status of detectorintintintgetId()doubleReturns the size of images produced, in MBReturns the filename of the last image created.doubleReturns the largest dimension of the detector face in mm.doubledoubledoubleintintgetSizeX()intgetSizeY()Returns the suffix currently given to all images createdReturns the type of the detectorbooleanvoidinitialiseDataSet(DetectorCollectionParameters datasetParameters) Informs the detector that a collection of images with incremental names will be created.booleanisBusy()booleanIndicates whether this object should be configured at startup.booleanvoidRe-initialisation of values and states.voidsetAttribute(String attributeName, Object value) Set any attribute the implementing classes may providevoidsetConfigureAtStartup(boolean doConfigureAtStartup) voidsetDetector(Detector detector) voidsetProtectionLevel(int newLevel) Sets the permission level for this object.voidStart data collectionvoidstop()Stops the current operation.voidReturns when the detector has finished its currently operation.Methods inherited from class gda.factory.FindableConfigurableBase
getName, setNameMethods inherited from class gda.factory.ConfigurableBase
configure, isConfigured, setConfiguredMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface gda.factory.Configurable
configure, isConfigured
-
Constructor Details
-
DetectorProxy
public DetectorProxy()
-
-
Method Details
-
isConfigureAtStartup
public boolean isConfigureAtStartup()Description copied from interface:ConfigurableIndicates whether this object should be configured at startup.Moved from ConditionallyConfigurable which has been deleted
- Specified by:
isConfigureAtStartupin interfaceConfigurable- Overrides:
isConfigureAtStartupin classConfigurableBase
-
setConfigureAtStartup
public void setConfigureAtStartup(boolean doConfigureAtStartup) -
getDetector
- Throws:
IllegalStateException
-
hasDetector
public boolean hasDetector() -
setDetector
-
setAttribute
Description copied from interface:DeviceSet any attribute the implementing classes may provide- Specified by:
setAttributein interfaceDevice- Parameters:
attributeName- is the name of the attributevalue- is the value of the attribute- Throws:
DeviceException- if an attribute cannot be set
-
getAttribute
Description copied from interface:DeviceGet the value of the specified attribute- Specified by:
getAttributein interfaceDevice- 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
Description copied from interface:DeviceClose and unconfigure the device.- Specified by:
closein interfaceDevice- Throws:
DeviceException
-
setProtectionLevel
public void setProtectionLevel(int newLevel) Description copied from interface:DeviceSets the permission level for this object. If this is not set then a default value will be applied.- Specified by:
setProtectionLevelin interfaceDevice- Parameters:
newLevel-
-
getProtectionLevel
public int getProtectionLevel()- Specified by:
getProtectionLevelin interfaceDevice- Returns:
- int - the permission level for this object.
-
addIObserver
public void addIObserver(gda.observable.IObserver observer) - Specified by:
addIObserverin interfacegda.observable.IObservable
-
deleteIObserver
public void deleteIObserver(gda.observable.IObserver observer) - Specified by:
deleteIObserverin interfacegda.observable.IObservable
-
deleteIObservers
public void deleteIObservers()- Specified by:
deleteIObserversin interfacegda.observable.IObservable
-
abort
Description copied from interface:DetectorAborts 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:
abortin interfaceDetector- Throws:
DeviceException
-
getDetectorStatus
Description copied from interface:DetectorReturns current status of detector- Specified by:
getDetectorStatusin interfaceDetector- Returns:
- DetectorStatus
- Throws:
DeviceException
-
getImageMB
Description copied from interface:DetectorReturns the size of images produced, in MB- Specified by:
getImageMBin interfaceDetector- Returns:
- double
- Throws:
DeviceException
-
getLastImageName
Description copied from interface:DetectorReturns the filename of the last image created.- Specified by:
getLastImageNamein interfaceDetector- Returns:
- String
- Throws:
DeviceException
-
getSizeX
public int getSizeX() -
getSizeY
public int getSizeY() -
getMaxDimension
Description copied from interface:DetectorReturns the largest dimension of the detector face in mm.- Specified by:
getMaxDimensionin interfaceDetector- Returns:
- double
- Throws:
DeviceException
-
getSuffix
Description copied from interface:DetectorReturns the suffix currently given to all images created- Specified by:
getSuffixin interfaceDetector- Returns:
- String
- Throws:
DeviceException
-
getTypeString
Description copied from interface:DetectorReturns the type of the detector- Specified by:
getTypeStringin interfaceDetector- Returns:
- String
-
initialiseDataSet
public void initialiseDataSet(DetectorCollectionParameters datasetParameters) throws DeviceException Description copied from interface:DetectorInforms 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:
initialiseDataSetin interfaceDetector- Parameters:
datasetParameters-- Throws:
DeviceException
-
start
Description copied from interface:DetectorStart data collection- Specified by:
startin interfaceDetector- Parameters:
file- - the name of the file to createomegaStart- - the starting angle of data collection (to go into image header)- Throws:
DeviceException
-
stop
Description copied from interface:StoppableStops the current operation.- Specified by:
stopin interfaceStoppable- Throws:
DeviceException
-
waitForReady
Description copied from interface:DetectorReturns when the detector has finished its currently operation. If its idle then returns immediately.- Specified by:
waitForReadyin interfaceDetector- Throws:
DeviceException
-
getDimensionInMm
- Specified by:
getDimensionInMmin interfaceDetector
-
isBusy
- Specified by:
isBusyin interfaceDetector- Throws:
DeviceException
-
enableRoiMode
- Specified by:
enableRoiModein interfaceDetector- Throws:
DeviceException
-
disableRoiMode
- Specified by:
disableRoiModein interfaceDetector- Throws:
DeviceException
-
isInRoiMode
- Specified by:
isInRoiModein interfaceDetector- Throws:
DeviceException
-
getFullSizeX
public int getFullSizeX()- Specified by:
getFullSizeXin interfaceDetector
-
getFullSizeY
public int getFullSizeY()- Specified by:
getFullSizeYin interfaceDetector
-
getFullDimensionInMm
- Specified by:
getFullDimensionInMmin interfaceDetector
-
getMaxFullDimension
public double getMaxFullDimension()- Specified by:
getMaxFullDimensionin interfaceDetector
-
reconfigure
Description copied from interface:ConfigurableRe-initialisation of values and states.Moved from Reconfigurable which has been deleted
- Specified by:
reconfigurein interfaceConfigurable- Overrides:
reconfigurein classConfigurableBase- Throws:
FactoryException
-
getAutoRunNumberUtils
- Specified by:
getAutoRunNumberUtilsin interfaceDetector- Throws:
DeviceException
-
getId
public int getId() -
getMinExposureTime
public double getMinExposureTime()- Specified by:
getMinExposureTimein interfaceDetector
-
getMinStillExposureTime
public double getMinStillExposureTime()- Specified by:
getMinStillExposureTimein interfaceDetector
-