Package gda.scan

Class ExplicitScanObject

java.lang.Object

gda.scan.ScanObject

gda.scan.ExplicitScanObject

All Implemented Interfaces:

Iterable<Object>, IExplicitScanObject, IScanObject

public class ExplicitScanObject
extends ScanObject
implements IExplicitScanObject

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

Constructor	Description
ExplicitScanObject(Scannable scannable, ScanPositionProvider pointProvider)

Method Summary

Modifier and Type	Method	Description
String	arePointsValid()	Checks whether the points in this scan object are valid.
int	getNumberPoints()	The number of points this object can move its scannable to.
Object	getPoint(int index)	Get the point and the given index.
IScanObject.ScanObjectType	getType()
boolean	hasStart()
boolean	hasStop()
Iterator<Object>	iterator()
ScanStepId	moveStep()	Move the scannable to its next position
ScanStepId	moveToStart()	Move the scannable to the start position
String	toString()

Methods inherited from class gda.scan.ScanObject

getScannable

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.gda.api.scan.IScanObject

getScannable

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ExplicitScanObject

public ExplicitScanObject(Scannable scannable,
 ScanPositionProvider pointProvider)

Parameters:

scannable -

pointProvider -

Method Details

getType

public IScanObject.ScanObjectType getType()

Specified by:

getType in interface IScanObject

moveToStart

public ScanStepId moveToStart()
                       throws Exception

Description copied from interface: IScanObject

Move the scannable to the start position

Specified by:

moveToStart in interface IScanObject

Throws:

Exception

moveStep

public ScanStepId moveStep()
                    throws Exception

Description copied from interface: IScanObject

Move the scannable to its next position

Specified by:

moveStep in interface IScanObject

Throws:

Exception

getNumberPoints

public int getNumberPoints()

Description copied from interface: IScanObject

The number of points this object can move its scannable to.

Specified by:

getNumberPoints in interface IScanObject

Returns:

the size of the array of points

getPoint

public Object getPoint(int index)

Description copied from interface: IExplicitScanObject

Get the point and the given index.

Specified by:

getPoint in interface IExplicitScanObject

Parameters:

index -

Returns:

the point

arePointsValid

public String arePointsValid()
                      throws DeviceException

Description copied from interface: IScanObject

Checks whether the points in this scan object are valid. Note that for IImplicitScanObjects, IImplicitScanObject.calculateScanPoints() must have been called first.

Specified by:

arePointsValid in interface IScanObject

Returns:

null if 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:

hasStart in interface IScanObject

Returns:

true if the object has a defined start position

hasStop

public boolean hasStop()

Specified by:

hasStop in interface IScanObject

Returns:

true if the object has a defined stop position (i.e. defines an entire scan)

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

toString

public String toString()

Overrides:

toString in class Object