Package gda.scan

Class ConcurrentScanChild

java.lang.Object

gda.scan.ScanBase

gda.scan.ConcurrentScanChild

All Implemented Interfaces:

IConcurrentScanChild, NestableScan, Scan, ScanChild, Serializable

Direct Known Subclasses:

ConcurrentScan, ContinuousScan, EdeScan

public abstract class ConcurrentScanChild
extends ScanBase
implements IConcurrentScanChild

Base class for scan classes which can act as a dimension in a multi-dimensional concurrentscan

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	ConcurrentScanChild.PointPositionInLine

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 List<IConcurrentScanChild>	allChildScans
protected List<IScanObject>	allScanObjects
protected FutureTask<Void>	detectorReadoutTask
protected SortedMap<Integer,Scannable[]>	scannableLevels

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
ConcurrentScanChild()

Method Summary

Modifier and Type	Method	Description
protected void	acquirePoint(boolean start, boolean collectDetectors)	Moves to the next step unless start is true, then moves to the start of the current (possibly child) scan.
protected void	cancelReadoutAndPublishCompletion()	Cancels readout and publish completion task.
protected void	checkAllMovesComplete()
protected SortedMap<Integer,Scannable[]>	generateDevicesToMoveByLevel(SortedMap<Integer,Scannable[]> scannableLevels, List<Detector> detectors)
List<IConcurrentScanChild>	getAllChildScans()
List<Detector>	getAllDetectors()
List<Scannable>	getAllScannables()
List<IScanObject>	getAllScanObjects()
IConcurrentScanChild	getChild()
String	getCommand()
protected final ConcurrentScanChild.PointPositionInLine	getPointPositionInLine()
SortedMap<Integer,Scannable[]>	getScannableLevels()
boolean	isMustBeFinal()
boolean	isReadoutConcurrent()
protected final boolean	isScannableActuallyToBeMoved(Scannable scannable)
protected IScanObject	isScannableToBeMoved(Scannable scannable)	Asks if the given scannable is part of the array of scannables which this scan is to operate in its moveToStarts and moveBySteps methods.
protected void	readoutDetectorsAndPublish(ScanDataPoint point)	Asynchronously, readout detectors using parallel threads into ScanDataPoint and add to pipeline for possible completion and publishing.
protected void	reorderAllScanObjects()
void	setAllChildScans(List<IConcurrentScanChild> allChildScans)
void	setAllDetectors(List<Detector> allDetectors)
void	setAllScannables(List<Scannable> allScannables)
void	setAllScanObjects(List<IScanObject> allScanObjects)
void	setChild(IConcurrentScanChild child)
void	setCommand(String command)
void	setMustBeFinal(boolean mustBeFinal)
protected final void	setPointPositionInLine(ConcurrentScanChild.PointPositionInLine pointPositionInLine)
void	setScannableLevels(SortedMap<Integer,Scannable[]> scannableLevels)
void	setStatus(Scan.ScanStatus status)	To allow nests of scans to share a common status with each other.
void	setTotalNumberOfPoints(int totalNumberOfPoints)	Enables parent scans, when creating the list of nested scans, to tell child scans the totalnumber of points in the overall multi-dimensional scan
protected void	setUp()	This should be called by all scans during their constructor.
void	waitForDetectorReadoutAndPublishCompletion()	Blocks while detectors are readout and point is added to pipeline.

Methods inherited from class gda.scan.ScanBase

callAtCommandFailureHooks, callDetectorsEndCollection, callScannablesAtScanEnd, callScannablesAtScanLineEnd, callScannablesAtScanLineStart, callScannablesAtScanStart, checkStartStopStep, checkThreadInterrupted, collectData, createScanDataPoint, createScanDataPointPipeline, createScanDataPointPipeline, doCollection, endScan, generateRandomName, 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, reorderScannables, representThrowable, requestFinishEarly, resume, run, runScan, scanRunning, sendScanEvent, setChild, setDataWriter, setDetectors, setIsChild, setLineScanNeedsDoing, setNumberOfChildScans, setParent, setPositionCallableThreadPoolSize, setScanDataPointPipeline, setScanDataPointQueueLength, setScanIdentifierInScanDataPoint, setScannables, setScanNumber, setScanPlotSettings, setStatus, setStepId, shutdownScandataPipeline, signalScanComplete, signalScanStarted, sortArguments, waitIfPaused, wasScanExplicitlyHalted, wrappedException

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.scan.IConcurrentScanChild

getTotalNumberOfPoints

Methods inherited from interface gda.scan.Scan

doCollection, getDataWriter, getDetectors, getDimension, getName, getScanDataPointPipeline, getScanInformation, getScannables, getScanNumber, getScanPlotSettings, getStatus, getStepId, isChild, isFinishEarlyRequested, pause, prepareForCollection, requestFinishEarly, resume, run, runScan, setChild, setDataWriter, setDetectors, setIsChild, setScanDataPointPipeline, setScannables, setScanPlotSettings, setStepId

Methods inherited from interface gda.scan.ScanChild

getParent, setParent

Field Details

scannableLevels

protected SortedMap<Integer,Scannable[]> scannableLevels

allScanObjects

protected List<IScanObject> allScanObjects

allChildScans

protected List<IConcurrentScanChild> allChildScans

detectorReadoutTask

protected FutureTask<Void> detectorReadoutTask

Constructor Details

ConcurrentScanChild

public ConcurrentScanChild()

Method Details

getPointPositionInLine

protected final ConcurrentScanChild.PointPositionInLine getPointPositionInLine()

setPointPositionInLine

protected final void setPointPositionInLine(ConcurrentScanChild.PointPositionInLine pointPositionInLine)

isReadoutConcurrent

public boolean isReadoutConcurrent()

getChild

public IConcurrentScanChild getChild()

Specified by:

getChild in interface IConcurrentScanChild

Specified by:

getChild in interface Scan

Overrides:

getChild in class ScanBase

Returns:

The child scan if this scan is nested

setChild

public void setChild(IConcurrentScanChild child)

Specified by:

setChild in interface IConcurrentScanChild

Parameters:

child -

getScannableLevels

public SortedMap<Integer,Scannable[]> getScannableLevels()

Specified by:

getScannableLevels in interface IConcurrentScanChild

Returns:

Returns the scannableLevels.

setScannableLevels

public void setScannableLevels(SortedMap<Integer,Scannable[]> scannableLevels)

Specified by:

setScannableLevels in interface IConcurrentScanChild

Parameters:

scannableLevels - The scannableLevels to set.

getAllScanObjects

public List<IScanObject> getAllScanObjects()

Specified by:

getAllScanObjects in interface IConcurrentScanChild

Returns:

Returns the allScanObjects.

setAllScanObjects

public void setAllScanObjects(List<IScanObject> allScanObjects)

Specified by:

setAllScanObjects in interface IConcurrentScanChild

Parameters:

allScanObjects - The allScanObjects to set.

getAllChildScans

public List<IConcurrentScanChild> getAllChildScans()

Specified by:

getAllChildScans in interface IConcurrentScanChild

Returns:

Returns the allChildScans.

setAllChildScans

public void setAllChildScans(List<IConcurrentScanChild> allChildScans)

Specified by:

setAllChildScans in interface IConcurrentScanChild

Parameters:

allChildScans - The allChildScans to set.

getAllScannables

public List<Scannable> getAllScannables()

Specified by:

getAllScannables in interface IConcurrentScanChild

Returns:

Returns the allScannables.

setAllScannables

public void setAllScannables(List<Scannable> allScannables)

Specified by:

setAllScannables in interface IConcurrentScanChild

Parameters:

allScannables - The allScannables to set.

getAllDetectors

public List<Detector> getAllDetectors()

Specified by:

getAllDetectors in interface IConcurrentScanChild

Returns:

Returns the allDetectors.

setAllDetectors

public void setAllDetectors(List<Detector> allDetectors)

Specified by:

setAllDetectors in interface IConcurrentScanChild

Parameters:

allDetectors - The allDetectors to set.

getCommand

public String getCommand()

Specified by:

getCommand in interface IConcurrentScanChild

Returns:

Returns the command.

setCommand

public void setCommand(String command)

Specified by:

setCommand in interface IConcurrentScanChild

setMustBeFinal

public void setMustBeFinal(boolean mustBeFinal)

isMustBeFinal

public boolean isMustBeFinal()

Specified by:

isMustBeFinal in interface IConcurrentScanChild

Returns:

true if the type of scan must tbe the innermost dimension of a set of nested scans (a multi-dimensional scan)

setTotalNumberOfPoints

public void setTotalNumberOfPoints(int totalNumberOfPoints)

Description copied from interface: IConcurrentScanChild

Enables parent scans, when creating the list of nested scans, to tell child scans the totalnumber of points in the overall multi-dimensional scan

Specified by:

setTotalNumberOfPoints in interface IConcurrentScanChild

Parameters:

totalNumberOfPoints -

acquirePoint

protected void acquirePoint(boolean start,
 boolean collectDetectors)
                     throws Exception

Moves to the next step unless start is true, then moves to the start of the current (possibly child) scan.

Throws:

Exception

generateDevicesToMoveByLevel

protected SortedMap<Integer,Scannable[]> generateDevicesToMoveByLevel(SortedMap<Integer,Scannable[]> scannableLevels,
 List<Detector> detectors)

isScannableToBeMoved

protected IScanObject isScannableToBeMoved(Scannable scannable)

Asks if the given scannable is part of the array of scannables which this scan is to operate in its moveToStarts and moveBySteps methods. If true returns the ScanObject else returns null.

Parameters:

scannable -

Returns:

the ScanObject

isScannableActuallyToBeMoved

protected final boolean isScannableActuallyToBeMoved(Scannable scannable)

checkAllMovesComplete

protected void checkAllMovesComplete()
                              throws Exception

Throws:

Exception

setUp

protected void setUp()

Description copied from class: ScanBase

This should be called by all scans during their constructor. In this method the objects to scan over and the detectors to use are identified, and the data handlers objects are created and setup.

Overrides:

setUp in class ScanBase

reorderAllScanObjects

protected void reorderAllScanObjects()

readoutDetectorsAndPublish

protected void readoutDetectorsAndPublish(ScanDataPoint point)
                                   throws Exception

Asynchronously, readout detectors using parallel threads into ScanDataPoint and add to pipeline for possible completion and publishing. Call waitForDetectorReadoutAndPublishCompletion() to wait for this task to complete, or cancelReadoutAndPublishCompletion() to cancel and interrupt it.

If the property LocalProperties.GDA_SCAN_CONCURRENTSCAN_READOUT_CONCURRENTLY is its default false value then simply block while reading out each detector in series and then adding the ScanDataPoint to the pipeline.

Overrides:

readoutDetectorsAndPublish in class ScanBase

Parameters:

point -

Throws:

Exception

waitForDetectorReadoutAndPublishCompletion

public void waitForDetectorReadoutAndPublishCompletion()
                                                throws InterruptedException,
ExecutionException

Blocks while detectors are readout and point is added to pipeline. Throws an exception if one was thrown while reading out the detectors or adding the point to the pipeline.

Overrides:

waitForDetectorReadoutAndPublishCompletion in class ScanBase

Throws:

InterruptedException

ExecutionException

cancelReadoutAndPublishCompletion

protected void cancelReadoutAndPublishCompletion()

Cancels readout and publish completion task.

Overrides:

cancelReadoutAndPublishCompletion in class ScanBase

setStatus

void setStatus(Scan.ScanStatus status)

To allow nests of scans to share a common status with each other.

Parameters:

status -