Package gda.scan

Class AsynchronousTimeScan

java.lang.Object

gda.scan.ScanBase

gda.scan.AsynchronousTimeScan

All Implemented Interfaces:

NestableScan, Scan, ScanChild, Serializable

public class AsynchronousTimeScan
extends ScanBase

An asynchronous timeScan that can be started collecting data and read out at intervals during continuous data collection

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

Modifier and Type	Field	Description
protected Vector<Detector>	asynchronousDetectors
DummyScannable	relativeTime	for observers to identify the relative time of the last data point from the start of the scan.

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
AsynchronousTimeScan(Detector detector, double totalTime)	Create an asynchronous timeScan that can be started collecting data and read out at intervals during continuous data collection

Method Summary

Modifier and Type	Method	Description
void	doCollection()	Collect the data asynchronously i.e.
void	endScan()	This should be called by all scans when they have finished, including when an exception has been raised.
protected void	readout()	readout whatever pseudo-data the detector has to offer whilst it is continually collecting (might not be the raw data!)
static void	runScan(Detector detector, double totalTime, double readoutinterval)	Create and run a scan
protected void	waitUntil(long targetTime)	Given a Java time in seconds, wait until that point and then return.

Methods inherited from class gda.scan.ScanBase

callAtCommandFailureHooks, callDetectorsEndCollection, callScannablesAtScanEnd, callScannablesAtScanLineEnd, callScannablesAtScanLineStart, callScannablesAtScanStart, cancelReadoutAndPublishCompletion, checkStartStopStep, checkThreadInterrupted, collectData, createScanDataPoint, createScanDataPointPipeline, createScanDataPointPipeline, generateRandomName, getChild, getDataWriter, getDetectors, getDimension, 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

Field Details

asynchronousDetectors

protected Vector<Detector> asynchronousDetectors

relativeTime

public volatile DummyScannable relativeTime

for observers to identify the relative time of the last data point from the start of the scan. This is a DummyScannable object so that data handlers will work properly.

Constructor Details

AsynchronousTimeScan

public AsynchronousTimeScan(Detector detector,
 double totalTime)

Create an asynchronous timeScan that can be started collecting data and read out at intervals during continuous data collection

Parameters:

detector - the detector to be scanned

totalTime - total collect time in milliseconds

Method Details

doCollection

public void doCollection()
                  throws InterruptedException,
DeviceException

Collect the data asynchronously i.e. let the detector do all point iterations. In this case readout() will behave in an unusual way and will be detector specific, real data read out being handled by the detector itself

Specified by:

doCollection in interface Scan

Specified by:

doCollection in class ScanBase

Throws:

InterruptedException

DeviceException

See Also:

• Scan.doCollection()

endScan

public 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

readout

protected void readout()
                throws Exception

readout whatever pseudo-data the detector has to offer whilst it is continually collecting (might not be the raw data!)

Throws:

Exception

waitUntil

protected void waitUntil(long targetTime)
                  throws InterruptedException

Given a Java time in seconds, wait until that point and then return. If that time has passed, then return immediately;

Parameters:

targetTime - time in milli-seconds

Throws:

InterruptedException

runScan

public static void runScan(Detector detector,
 double totalTime,
 double readoutinterval)
                    throws InterruptedException,
Exception

Create and run a scan

Parameters:

detector - the detector object to be scanned

totalTime - total collect time in milli-seconds

readoutinterval - time after which pseudo-data is to be read out during continuous data collection in milli-seconds

Throws:

InterruptedException

Exception