Package gda.scan
Class ExplicitScanObject
java.lang.Object
gda.scan.ScanObject
gda.scan.ExplicitScanObject
- All Implemented Interfaces:
Iterable<Object>,IExplicitScanObject,IScanObject
-
Nested Class Summary
Nested classes/interfaces inherited from interface uk.ac.gda.api.scan.IScanObject
IScanObject.ScanObjectType -
Field Summary
Fields inherited from class gda.scan.ScanObject
scannable -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionChecks whether the points in this scan object are valid.intThe number of points this object can move its scannable to.getPoint(int index) Get the point and the given index.getType()booleanhasStart()booleanhasStop()iterator()moveStep()Move the scannable to its next positionMove the scannable to the start positiontoString()Methods inherited from class gda.scan.ScanObject
getScannableMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface uk.ac.gda.api.scan.IScanObject
getScannableMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
ExplicitScanObject
- Parameters:
scannable-pointProvider-
-
-
Method Details
-
getType
- Specified by:
getTypein interfaceIScanObject
-
moveToStart
Description copied from interface:IScanObjectMove the scannable to the start position- Specified by:
moveToStartin interfaceIScanObject- Throws:
Exception
-
moveStep
Description copied from interface:IScanObjectMove the scannable to its next position- Specified by:
moveStepin interfaceIScanObject- Throws:
Exception
-
getNumberPoints
public int getNumberPoints()Description copied from interface:IScanObjectThe number of points this object can move its scannable to.- Specified by:
getNumberPointsin interfaceIScanObject- Returns:
- the size of the array of points
-
getPoint
Description copied from interface:IExplicitScanObjectGet the point and the given index.- Specified by:
getPointin interfaceIExplicitScanObject- Parameters:
index-- Returns:
- the point
-
arePointsValid
Description copied from interface:IScanObjectChecks whether the points in this scan object are valid. Note that forIImplicitScanObjects,IImplicitScanObject.calculateScanPoints()must have been called first.- Specified by:
arePointsValidin interfaceIScanObject- Returns:
nullif all points in the array of points are valid for the scannable, or the toString() of the point which is unacceptable- Throws:
DeviceException
-
hasStart
public boolean hasStart()- Specified by:
hasStartin interfaceIScanObject- Returns:
- true if the object has a defined start position
-
hasStop
public boolean hasStop()- Specified by:
hasStopin interfaceIScanObject- Returns:
- true if the object has a defined stop position (i.e. defines an entire scan)
-
iterator
-
toString
-