Package gda.scan

Class UndulatorTuningGridScan

java.lang.Object

gda.scan.ScanBase

gda.scan.GridScan

gda.scan.GridScanMoveToOnly

gda.scan.UndulatorTuningGridScan

All Implemented Interfaces:

NestableScan, Scan, ScanChild, Serializable

public class UndulatorTuningGridScan
extends GridScanMoveToOnly

Class to control the stepped movement of a Scannable object.

At each step, after movement, the readout() method of all object in the DetectorBase.activeDetectors arraylist is called.

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

childScan, period, scriptAdapter, start, step, stop, theScannable, time, units

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
UndulatorTuningGridScan(Scannable ve, Object start, Object stop, Object step, Object time, Object units, Scannable extraScannable, Object frequency, Scannable toBeReportedOne, Scannable toBeReportedTwo)

Method Summary

Modifier and Type	Method	Description
void	moveStepIncrement(int index)
void	moveToStart()	Move the object of this scan to its initial position.

Methods inherited from class gda.scan.GridScan

doCollection, hasChild, runChildScan, setupGridScan

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

Constructor Details

UndulatorTuningGridScan

public UndulatorTuningGridScan(Scannable ve,
 Object start,
 Object stop,
 Object step,
 Object time,
 Object units,
 Scannable extraScannable,
 Object frequency,
 Scannable toBeReportedOne,
 Scannable toBeReportedTwo)

Parameters:

ve -

start -

stop -

step -

time -

units -

extraScannable -

frequency -

toBeReportedOne -

toBeReportedTwo -

Method Details

moveStepIncrement

public void moveStepIncrement(int index)
                       throws Exception

Overrides:

moveStepIncrement in class GridScanMoveToOnly

Parameters:

index - int

Throws:

Exception

moveToStart

public void moveToStart()
                 throws Exception

Description copied from class: GridScan

Move the object of this scan to its initial position.

Overrides:

moveToStart in class GridScan

Throws:

Exception