Package gda.scan

Class MultiScan

java.lang.Object

gda.scan.ScanBase

gda.scan.MultiScan

All Implemented Interfaces:

ContiguousScan, NestableScan, Scan, ScanChild, Serializable

public class MultiScan
extends ScanBase
implements ContiguousScan

See Also:

• Serialized Form

Nested Class Summary

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

Constructor	Description
MultiScan(List<ScanBase> scans)

Method Summary

Modifier and Type	Method	Description
void	doCollection()	The method in which the work of the scan is performed.
protected void	endScan()	This should be called by all scans when they have finished, including when an exception has been raised.
ScanBase	getCurrentRunningScan()
int	getDimension()	default implementation.
int	getNumberOfContiguousPoints()
void	prepareForCollection()	This should called by all scans just before they start to collect data.
void	setCurrentRunningScan(ScanBase currentRunningScan)

Methods inherited from class gda.scan.ScanBase

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

Methods inherited from class java.lang.Object

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

Constructor Details

MultiScan

public MultiScan(List<ScanBase> scans)

Method Details

getDimension

public int getDimension()

Description copied from class: ScanBase

default implementation. Classes that derive from ScanBase which want to support the reporting of scan dimensions -@see getDimensions need to override this method

Specified by:

getDimension in interface Scan

Overrides:

getDimension in class ScanBase

Returns:

the number of points of this scan object - the whole scan execution can be a hierarchy of parent scan objects and layers of child scan objects

See Also:

• ConcurrentScan

getNumberOfContiguousPoints

public int getNumberOfContiguousPoints()

Specified by:

getNumberOfContiguousPoints in interface ContiguousScan

prepareForCollection

public void prepareForCollection()
                          throws Exception

Description copied from class: ScanBase

This should called by all scans just before they start to collect data. It resets the static variable which the scan classes use and creates a dataHandler if one has not been created yet.

Specified by:

prepareForCollection in interface Scan

Overrides:

prepareForCollection in class ScanBase

Throws:

Exception

endScan

protected void endScan()
                throws DeviceException,
InterruptedException

Description copied from class: ScanBase

This should be called by all scans when they have finished, including when an exception has been raised.

Overrides:

endScan in class ScanBase

Throws:

DeviceException

InterruptedException

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

Specified by:

doCollection in class ScanBase

Throws:

Exception

getCurrentRunningScan

public ScanBase getCurrentRunningScan()

setCurrentRunningScan

public void setCurrentRunningScan(ScanBase currentRunningScan)