IImplicitScanObject

All Superinterfaces:: IScanObject

All Known Implementing Classes:: ImplicitScanObject

public interface IImplicitScanObject extends IScanObject

A scan object defined implicitly by start, stop and step positions. Note that any or all of these values may not be specified (i.e. are null).

Nested Class Summary

Nested classes/interfaces inherited from interface uk.ac.gda.api.scan.IScanObject
IScanObject.ScanObjectType
Method Summary

Modifier and Type

Method

Description

void

calculateScanPoints()

Calculate the points of the scan.

Object

getStart()

Object

getStep()

Object

getStop()

boolean

hasStep()

void

setNumberPoints(int numberPoints)

Set the number of points to move to.

Methods inherited from interface uk.ac.gda.api.scan.IScanObject
arePointsValid, getNumberPoints, getScannable, getType, hasStart, hasStop, moveStep, moveToStart

Method Details
- setNumberPoints
  
  void setNumberPoints(int numberPoints)
  
  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.
  
  Parameters:
  
  numberPoints -
- getStart
  
  Object getStart()
- getStop
  
  Object getStop()
- getStep
  
  Object getStep()
- hasStep
  
  boolean hasStep()
- calculateScanPoints
  
  void calculateScanPoints()
  
  Calculate the points of the scan. This method must be called before IScanObject.arePointsValid() is called and before the scan starts. The method setNumberPoints(int) should be called before calling this method if necessary (for example if stop isn't set).