Package gda.scan

Class ImplicitScanObject

java.lang.Object

gda.scan.ScanObject

gda.scan.ImplicitScanObject

All Implemented Interfaces:

IImplicitScanObject, IScanObject

public class ImplicitScanObject
extends ScanObject
implements IImplicitScanObject

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
ImplicitScanObject(Scannable scannable, Object start, Object stop, Object step)

Method Summary

Modifier and Type	Method	Description
String	arePointsValid()	Checks whether the points in this scan object are valid.
void	calculateScanPoints()	Fill the array of points to move the scannable to
int	getNumberPoints()	The number of points this object can move its scannable to.
Object	getStart()
Object	getStep()
Object	getStop()
IScanObject.ScanObjectType	getType()
boolean	hasStart()
boolean	hasStep()
boolean	hasStop()
ScanStepId	moveStep()	Move the scannable to its next position
ScanStepId	moveToStart()	Move the scannable to the start position
void	setNumberPoints(int number)	Set the number of points to move to.
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

Constructor Details

ImplicitScanObject

public ImplicitScanObject(Scannable scannable,
 Object start,
 Object stop,
 Object step)

Parameters:

scannable -

start -

stop -

step -

Method Details

getType

public IScanObject.ScanObjectType getType()

Specified by:

getType in interface IScanObject

setNumberPoints

public void setNumberPoints(int number)

Description copied from interface: IImplicitScanObject

Set the number of points to move to. This should be used when the scan object does not initially have enough information to know this, for example if only start and stop are specified - this can be the case for scannable s2 in the scan command scan s1 0 5 1 s2 0 10, where the second scannable only has start and step defined. This method will be called with to set the size of this scan object to be the same as that for scannable s1.

Specified by:

setNumberPoints in interface IImplicitScanObject

Parameters:

number -

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

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

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

calculateScanPoints

public void calculateScanPoints()

Fill the array of points to move the scannable to

Specified by:

calculateScanPoints in interface IImplicitScanObject

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)

hasStep

public boolean hasStep()

Specified by:

hasStep in interface IImplicitScanObject

getStart

public Object getStart()

Specified by:

getStart in interface IImplicitScanObject

getStop

public Object getStop()

Specified by:

getStop in interface IImplicitScanObject

getStep

public Object getStep()

Specified by:

getStep in interface IImplicitScanObject

toString

public String toString()

Overrides:

toString in class Object