CoordinatesMove

All Known Subinterfaces:: Assembly, Beamline, Diffractometer, EndStation, Gonio, IndexPositioner, PlateLoader, SampleEnvironment

All Known Implementing Classes:: AbstractPlateLoader, AssemblyAdapter, AssemblyBase, DiffractometerBase, EndStationBase, GonioBase, PlateLoaderAdapter

public interface CoordinatesMove

Method Summary

Modifier and Type

Method

Description

void

asynchronousMoveToCoordinates(Coordinates coordinates)

Trigger a move/operation and return immediately.

boolean

checkMovementValid(Coordinates start, Coordinates target)

Coordinates

getCurrentCoordinates()

Returns the current predefined coordinates holder.

Collection<Coordinates>

getDefinedCoordinates()

void

moveToCoordinates(Coordinates coordinates)

Trigger a move/operation and block until completion.

Method Details
- asynchronousMoveToCoordinates
  
  void asynchronousMoveToCoordinates(Coordinates coordinates) throws DeviceException
  
  Trigger a move/operation and return immediately. Implementations of this method should be non-blocking to allow concurrent motion; the isBusy method will be used to determine when the move has completed.
  
  Parameters:
  
  coordinates - Coordinates to move to
  
  Throws:
  
  DeviceException
- checkMovementValid
  
  boolean checkMovementValid(Coordinates start, Coordinates target)
- getCurrentCoordinates
  
  Coordinates getCurrentCoordinates() throws DeviceException
  
  Returns the current predefined coordinates holder.
  
  Returns:
  
  Current Coordinate object with a position element for each scannable dimension.
  
  Throws:
  
  DeviceException
- getDefinedCoordinates
  
  Collection<Coordinates> getDefinedCoordinates()
- moveToCoordinates
  
  void moveToCoordinates(Coordinates coordinates) throws DeviceException
  
  Trigger a move/operation and block until completion.
  
  Throws:
  
  DeviceException