Package gda.scan

Class AbstractContinuousScanLine

java.lang.Object

gda.scan.ScanBase

gda.scan.ConcurrentScanChild

gda.scan.ConcurrentScan

gda.scan.AbstractContinuousScanLine

All Implemented Interfaces:

IConcurrentScanChild, NestableScan, Scan, ScanChild, Serializable

Direct Known Subclasses:

ConstantVelocityScanLine, TrajectoryScanLine

public abstract class AbstractContinuousScanLine
extends ConcurrentScan

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gda.scan.ConcurrentScanChild

ConcurrentScanChild.PointPositionInLine

Nested classes/interfaces inherited from class gda.scan.ScanBase

ScanBase.ParentScanComponent

Nested classes/interfaces inherited from interface gda.scan.Scan

Scan.ScanStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected List<HardwareTriggeredDetector>	detectors
protected boolean	detectorsIntegrateBetweenTriggers
protected List<ContinuouslyScannableViaController>	scannablesToMove

Fields inherited from class gda.scan.ConcurrentScan

numberSteps, RETURNTOSTARTINGPOSITION

Fields inherited from class gda.scan.ConcurrentScanChild

allChildScans, allScanObjects, detectorReadoutTask, scannableLevels

Fields inherited from class gda.scan.ScanBase

allDetectors, allScannables, callCollectDataOnDetectors, child, command, currentPointCount, GDA_SCANBASE_FIRST_SCAN_NUMBER_FOR_TEST, GDA_SCANBASE_PRINT_TIMESTAMP_TO_TERMINAL, instrument, isChild, name, numberOfChildScans, parent, parentComponent, permissionLevel, scanDataPointPipeline, stepId, totalNumberOfPoints

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractContinuousScanLine(Object[] args)

Method Summary

Modifier and Type	Method	Description
protected abstract void	configureControllerPositions(boolean detectorsIntegrateBetweenTriggers)
protected abstract void	configureControllerTriggerTimes()
void	doCollection()	The method in which the work of the scan is performed.
protected final double	extractCommonCollectionTimeFromDetectors()
protected void	extractScannablesToScan()
protected ContinuousMoveController	getController()
boolean	isReadoutConcurrent()
protected void	prepareDevicesForCollection()
void	setStatus(Scan.ScanStatus status)	To allow nests of scans to share a common status with each other.
protected void	stopDetectors()

Methods inherited from class gda.scan.ConcurrentScan

callAtPointStartHooks, createScanDataPoint, endScan, getDimension, getNumberPoints, getUserListedScannables, getUserListedScannablesToScan, isReturnScannablesToOrginalPositions, isSendUpdateEvents, reportDevicesByLevel, setReturnScannablesToOrginalPositions, setSendUpdateEvents

Methods inherited from class gda.scan.ConcurrentScanChild

acquirePoint, cancelReadoutAndPublishCompletion, checkAllMovesComplete, generateDevicesToMoveByLevel, getAllChildScans, getAllDetectors, getAllScannables, getAllScanObjects, getChild, getCommand, getPointPositionInLine, getScannableLevels, isMustBeFinal, isScannableActuallyToBeMoved, isScannableToBeMoved, readoutDetectorsAndPublish, reorderAllScanObjects, setAllChildScans, setAllDetectors, setAllScannables, setAllScanObjects, setChild, setCommand, setMustBeFinal, setPointPositionInLine, setScannableLevels, setTotalNumberOfPoints, setUp, waitForDetectorReadoutAndPublishCompletion

Methods inherited from class gda.scan.ScanBase

callAtCommandFailureHooks, callDetectorsEndCollection, callScannablesAtScanEnd, callScannablesAtScanLineEnd, callScannablesAtScanLineStart, callScannablesAtScanStart, checkStartStopStep, checkThreadInterrupted, collectData, createScanDataPointPipeline, createScanDataPointPipeline, generateRandomName, getDataWriter, getDetectors, getDimensions, getName, getNumberOfChildScans, getParent, getPositionCallableThreadPoolSize, getScanDataPointPipeline, getScanDataPointQueueLength, getScanInformation, getScannables, getScanNumber, getScanPlotSettings, getStatus, getStepId, getStepIds, getTotalNumberOfPoints, isChild, isFinishEarlyRequested, isLineScanNeedsDoing, notifyServer, notifyServer, numberOfScannablesThatCanProvidePositionCallables, pause, prepareForCollection, prepareScanForCollection, prepareScanNumber, prepareStaticVariables, readDevicesAndPublishScanDataPoint, reorderScannables, representThrowable, requestFinishEarly, resume, run, runScan, scanRunning, sendScanEvent, setChild, setDataWriter, setDetectors, setIsChild, setLineScanNeedsDoing, setNumberOfChildScans, setParent, setPositionCallableThreadPoolSize, setScanDataPointPipeline, setScanDataPointQueueLength, setScanIdentifierInScanDataPoint, setScannables, setScanNumber, setScanPlotSettings, setStatus, setStepId, shutdownScandataPipeline, signalScanComplete, signalScanStarted, sortArguments, waitIfPaused, wasScanExplicitlyHalted, wrappedException

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.scan.IConcurrentScanChild

getTotalNumberOfPoints

Methods inherited from interface gda.scan.Scan

getDataWriter, getDetectors, getName, getScanDataPointPipeline, getScanInformation, getScannables, getScanNumber, getScanPlotSettings, getStatus, getStepId, isChild, isFinishEarlyRequested, pause, prepareForCollection, requestFinishEarly, resume, run, runScan, setChild, setDataWriter, setDetectors, setIsChild, setScanDataPointPipeline, setScannables, setScanPlotSettings, setStepId

Methods inherited from interface gda.scan.ScanChild

getParent, setParent

Field Details

detectors

protected List<HardwareTriggeredDetector> detectors

scannablesToMove

protected List<ContinuouslyScannableViaController> scannablesToMove

detectorsIntegrateBetweenTriggers

protected boolean detectorsIntegrateBetweenTriggers

Constructor Details

AbstractContinuousScanLine

protected AbstractContinuousScanLine(Object[] args)
                              throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

isReadoutConcurrent

public boolean isReadoutConcurrent()

Overrides:

isReadoutConcurrent in class ConcurrentScanChild

extractScannablesToScan

protected void extractScannablesToScan()

prepareDevicesForCollection

protected void prepareDevicesForCollection()
                                    throws Exception

Overrides:

prepareDevicesForCollection in class ScanBase

Throws:

Exception

doCollection

public void doCollection()
                  throws Exception

Description copied from interface: Scan

The method in which the work of the scan is performed. This method assumes that the data handler has already been created and the baton claimed.

Specified by:

doCollection in interface Scan

Overrides:

doCollection in class ConcurrentScan

Throws:

Exception

configureControllerPositions

protected abstract void configureControllerPositions(boolean detectorsIntegrateBetweenTriggers)
                                              throws DeviceException,
InterruptedException,
Exception

Throws:

DeviceException

InterruptedException

Exception

extractCommonCollectionTimeFromDetectors

protected final double extractCommonCollectionTimeFromDetectors()
                                                         throws DeviceException

Throws:

DeviceException

configureControllerTriggerTimes

protected abstract void configureControllerTriggerTimes()
                                                 throws DeviceException

Throws:

DeviceException

stopDetectors

protected void stopDetectors()
                      throws DeviceException

Throws:

DeviceException

getController

protected ContinuousMoveController getController()

setStatus

void setStatus(Scan.ScanStatus status)

To allow nests of scans to share a common status with each other.

Parameters:

status -