Package gda.scan

Class TimeScan

java.lang.Object

gda.scan.ScanBase

gda.scan.TimeScan

All Implemented Interfaces:

NestableScan, Scan, ScanChild, Serializable

public class TimeScan
extends ScanBase

Performs a TimeScan experiments. In this scan, no beamline settings are changed - data is collected from a detector for periods of CollectTime, with periods of PauseTime in between up to a total time of TotalTime.

Time units are seconds.

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
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
TimeScan(int numberOfPoints, double pause, double collect)	Create a TimeScan object to scan all active detectors
TimeScan(int numberOfPoints, double pause, double collect, DataWriter datahandler)
TimeScan(Object ct, int numberOfPoints, double pause, double collect)	Create a TimeScan object to scan the detector specified
TimeScan(List<Detector> ct, int numberOfPoints, double pause, double collect)	Create a TimeScan object to scan the detector specified
TimeScan(List<Detector> ct, int numberOfPoints, double pause, double collect, DataWriter dw)	Create a TimeScan object to scan the detector specified

Method Summary

Modifier and Type	Method	Description
void	doCollection()	Collect the data
static void	runScan(int numberOfPoints, double pauseTime, double collectTime)	Creates and runs a scan
static void	runScan(DetectorBase detector, int numberOfPoints, double pauseTime, double collectTime)	Creates and runs a scan
protected void	waitUntil(long targetTime)	Given a Java time in miliseconds, waits until that point and then returns.

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

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

TimeScan

public TimeScan(Object ct,
 int numberOfPoints,
 double pause,
 double collect)

Create a TimeScan object to scan the detector specified

Parameters:

ct - the detector (counterTimer) to scan

numberOfPoints - the number of data points to collect

pause - the time between successive points of data collection

collect - the time of data collection

TimeScan

public TimeScan(List<Detector> ct,
 int numberOfPoints,
 double pause,
 double collect)

Create a TimeScan object to scan the detector specified

Parameters:

ct - the detector (counterTimer) to scan

numberOfPoints - the number of data points to collect

pause - the time between successive points of data collection

collect - the time of data collection

TimeScan

public TimeScan(List<Detector> ct,
 int numberOfPoints,
 double pause,
 double collect,
 DataWriter dw)

Create a TimeScan object to scan the detector specified

Parameters:

ct - the detector (counterTimer) to scan

numberOfPoints - the number of data points to collect

pause - the time between successive points of data collection

collect - the time of data collection

dw -

TimeScan

public TimeScan(int numberOfPoints,
 double pause,
 double collect)

Create a TimeScan object to scan all active detectors

Parameters:

numberOfPoints - the number of data points to collect

pause - the time between successive points of data collection

collect - the time of data collection

TimeScan

public TimeScan(int numberOfPoints,
 double pause,
 double collect,
 DataWriter datahandler)

Parameters:

numberOfPoints -

pause -

collect -

datahandler -

Method Details

doCollection

public void doCollection()
                  throws Exception

Collect the data

Specified by:

doCollection in interface Scan

Specified by:

doCollection in class ScanBase

Throws:

Exception

See Also:

• Scan.doCollection()

waitUntil

protected void waitUntil(long targetTime)
                  throws InterruptedException

Given a Java time in miliseconds, waits until that point and then returns. If that time has passed, then returns immediately;

Parameters:

targetTime - time in seconds

Throws:

InterruptedException

runScan

public static void runScan(DetectorBase detector,
 int numberOfPoints,
 double pauseTime,
 double collectTime)
                    throws InterruptedException,
Exception

Creates and runs a scan

Parameters:

detector - the device for data collection

numberOfPoints - the number of data points to collect

pauseTime - the time between successive points of data collection

collectTime - the time of data collection

Throws:

InterruptedException

Exception

runScan

public static void runScan(int numberOfPoints,
 double pauseTime,
 double collectTime)
                    throws InterruptedException,
Exception

Creates and runs a scan

Parameters:

numberOfPoints - the number of data points to collect

pauseTime - the time between successive points of data collection

collectTime - the time of data collection

Throws:

InterruptedException

Exception