Package gda.scan

Class StaticScan

java.lang.Object

gda.scan.ScanBase

gda.scan.StaticScan

All Implemented Interfaces:

NestableScan, Scan, ScanChild, Serializable

public class StaticScan
extends ScanBase

This 'scan' does not move anything but does instruct detectors to collect data, it calls getPosition() or readout() once and saves the data to a normal scan file.

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
StaticScan(Scannable[] args)

Method Summary

Modifier and Type	Method	Description
void	doCollection()	The method in which the work of the scan is performed.
int	getDimension()	default implementation.

Methods inherited from class gda.scan.ScanBase

callAtCommandFailureHooks, callDetectorsEndCollection, callScannablesAtScanEnd, callScannablesAtScanLineEnd, callScannablesAtScanLineStart, callScannablesAtScanStart, cancelReadoutAndPublishCompletion, checkStartStopStep, checkThreadInterrupted, collectData, createScanDataPoint, createScanDataPointPipeline, createScanDataPointPipeline, endScan, 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, prepareForCollection, 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

StaticScan

public StaticScan(Scannable[] args)
           throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

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

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