Package gda.device.scannable

Class CameraXYScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.CameraXYScannable

All Implemented Interfaces:

Device, Scannable, Configurable, Findable, gda.observable.IObservable, org.springframework.beans.factory.InitializingBean

@ServiceInterface(Scannable.class)
public class CameraXYScannable
extends ScannableBase
implements org.springframework.beans.factory.InitializingBean

Field Summary

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

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
CameraXYScannable()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	autoCentre(double pixelsX, double pixelsY)
void	configure()	Default implementation for classes that do not have to do any specific configuration. Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.
DisplayScaleProvider	getCameraScaleProvider()
Scannable	getCameraStageXScannable()
Scannable	getCameraStageYScannable()
String	getConfigurationName()
Scannable	getLensScannable()
String	getPropertyNameX()
String	getPropertyNameY()
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	setCameraScaleProvider(DisplayScaleProvider cameraScaleProvider)
void	setCameraStageXScannable(Scannable cameraStageXScannable)
void	setCameraStageYScannable(Scannable cameraStageYScannable)
void	setConfigurationName(String configurationName)
void	setLensScannable(Scannable lensScannable)
void	setPropertyNameX(String propertyNameX)
void	setPropertyNameY(String propertyNameY)

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

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

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

Constructor Details

CameraXYScannable

public CameraXYScannable()

Method Details

isBusy

public boolean isBusy()
               throws DeviceException

Description copied from interface: Scannable

Check if the Scannable is moving/operating.

Specified by:

isBusy in interface Scannable

Returns:

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

Throws:

DeviceException

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

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()

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.

Specified by:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

autoCentre

public void autoCentre(double pixelsX,
 double pixelsY)
                throws DeviceException,
InterruptedException

Throws:

DeviceException

InterruptedException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getConfigurationName

public String getConfigurationName()

setConfigurationName

public void setConfigurationName(String configurationName)

getPropertyNameX

public String getPropertyNameX()

setPropertyNameX

public void setPropertyNameX(String propertyNameX)

getPropertyNameY

public String getPropertyNameY()

setPropertyNameY

public void setPropertyNameY(String propertyNameY)

getCameraStageYScannable

public Scannable getCameraStageYScannable()

setCameraStageYScannable

public void setCameraStageYScannable(Scannable cameraStageYScannable)

getCameraStageXScannable

public Scannable getCameraStageXScannable()

setCameraStageXScannable

public void setCameraStageXScannable(Scannable cameraStageXScannable)

getCameraScaleProvider

public DisplayScaleProvider getCameraScaleProvider()

setCameraScaleProvider

public void setCameraScaleProvider(DisplayScaleProvider cameraScaleProvider)

getLensScannable

public Scannable getLensScannable()

setLensScannable

public void setLensScannable(Scannable lensScannable)