Package gda.device.scannable

Class ScanDataListenerScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.scannable.ScanEventHandlerScannable

gda.device.scannable.ScanDataListenerScannable

All Implemented Interfaces:

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

public abstract class ScanDataListenerScannable
extends ScanEventHandlerScannable
implements IScanDataPointObserver

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

Method Summary

Modifier and Type	Method	Description
void	atScanEnd()	Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).
void	atScanStart()	Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case)
protected int	getPositionOfDetector(String columnName, IScanDataPoint sdp)
protected int	getPositionOfScannable(String columnName, IScanDataPoint sdp)
protected int[]	getScanDimensions(IScanDataPoint sdp)
abstract void	handleScanDataPoint(IScanDataPoint sdp)
abstract void	handleScanEnd()
void	update(Object source, Object arg)

Methods inherited from class gda.device.scannable.ScanEventHandlerScannable

isBusy, log, rawAsynchronousMoveTo, rawGetPosition, toFormattedString, waitWhileBusy

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanLineEnd, atScanLineStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, 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.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

ScanDataListenerScannable

public ScanDataListenerScannable()

Method Details

atScanEnd

public void atScanEnd()
               throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the end of a group of nested scans (or a single scan if that is the case).

Note that this is only called if the Scan finishes normally, or has been requested to finish early. This will not be called if the scan finishes due to an exception of any kind. See Scannable.atCommandFailure() Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanEnd in interface Scannable

Overrides:

atScanEnd in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanEnd()

atScanStart

public void atScanStart()
                 throws DeviceException

Description copied from class: ScannableBase

Called for every Scannable at the start of a group of nested scans (or a single scan if that is the case) Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

atScanStart in interface Scannable

Overrides:

atScanStart in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.atScanStart()

handleScanDataPoint

public abstract void handleScanDataPoint(IScanDataPoint sdp)
                                  throws Exception

Throws:

Exception

handleScanEnd

public abstract void handleScanEnd()
                            throws Exception

Throws:

Exception

update

public void update(Object source,
 Object arg)

Specified by:

update in interface gda.observable.IObserver

getPositionOfScannable

protected int getPositionOfScannable(String columnName,
 IScanDataPoint sdp)

getPositionOfDetector

protected int getPositionOfDetector(String columnName,
 IScanDataPoint sdp)

getScanDimensions

protected int[] getScanDimensions(IScanDataPoint sdp)