Package gda.scan
Interface IConcurrentScanChild
- All Superinterfaces:
NestableScan,Scan,ScanChild,Serializable
- All Known Implementing Classes:
AbstractContinuousScanLine,ConcurrentScan,ConcurrentScanChild,ConstantVelocityRasterScan,ConstantVelocityScanLine,ContinuousScan,EdeScan,EdeScanWithTFGTrigger,TestScan,TrajectoryScanLine,TurboXasScan
Interface for access to scan objects which can be part of a multidimensional ConcurrentScan
-
Nested Class Summary
Nested classes/interfaces inherited from interface gda.scan.Scan
Scan.ScanStatus -
Method Summary
Modifier and TypeMethodDescriptiongetChild()intThe total number of points in the multi-dimesional scan i.e.booleanvoidsetAllChildScans(List<IConcurrentScanChild> allChildScans) voidsetAllDetectors(List<Detector> allDetectors) voidsetAllScannables(List<Scannable> allScannables) voidsetAllScanObjects(List<IScanObject> allScanObjects) voidsetChild(IConcurrentScanChild child) voidsetCommand(String command) voidsetScannableLevels(SortedMap<Integer, Scannable[]> scannableLevels) voidsetStatus(Scan.ScanStatus status) To allow nests of scans to share a common status with each other.voidsetTotalNumberOfPoints(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 scanMethods 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
-
Method Details
-
getChild
IConcurrentScanChild getChild() -
setChild
- Parameters:
child-
-
getScannableLevels
- Returns:
- Returns the scannableLevels.
-
setScannableLevels
- Parameters:
scannableLevels- The scannableLevels to set.
-
getAllScanObjects
List<IScanObject> getAllScanObjects()- Returns:
- Returns the allScanObjects.
-
setAllScanObjects
- Parameters:
allScanObjects- The allScanObjects to set.
-
getAllChildScans
List<IConcurrentScanChild> getAllChildScans()- Returns:
- Returns the allChildScans.
-
setAllChildScans
- Parameters:
allChildScans- The allChildScans to set.
-
getAllScannables
- Returns:
- Returns the allScannables.
-
setAllScannables
- Parameters:
allScannables- The allScannables to set.
-
getAllDetectors
- Returns:
- Returns the allDetectors.
-
setAllDetectors
- Parameters:
allDetectors- The allDetectors to set.
-
getCommand
String getCommand()- Returns:
- Returns the command.
-
getTotalNumberOfPoints
int getTotalNumberOfPoints()The total number of points in the multi-dimesional scan i.e. the number of ScanDataPoints which would need displaying/recording- Specified by:
getTotalNumberOfPointsin interfaceScan- Returns:
- int
-
isMustBeFinal
boolean isMustBeFinal()- Returns:
- true if the type of scan must tbe the innermost dimension of a set of nested scans (a multi-dimensional scan)
-
setCommand
-
setTotalNumberOfPoints
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- Parameters:
totalNumberOfPoints-
-
setStatus
To allow nests of scans to share a common status with each other.- Parameters:
status-
-