Package uk.ac.gda.component.model.api

Interface IndexMove

All Known Subinterfaces:
Assembly, Beamline, Diffractometer, EndStation, Gonio, IndexPositioner, PlateLoader, SampleEnvironment
All Known Implementing Classes:
AbstractPlateLoader, AssemblyAdapter, AssemblyBase, DiffractometerBase, EndStationBase, GonioBase, PlateLoaderAdapter
public interface IndexMove

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    asynchronousMoveToDefined(String coordinatesName)
    Trigger a move/operation to a pre-defined and indexed position and return immediately.
    void
    asynchronousMoveToIndex(int index)
     
    Set<String>
    getDefinedCoordinatesNames()
    Returns an array of the names of registered defined coordinates
    boolean
    isAt(String coordinatesToTest)
    Tests if the coordinates are at (or if appropriate, close to) the values in coordinatesToTest.
    boolean
    isAtIndex(int indexToTest)
     
    void
    moveToDefined(String coordinatesName)
    Trigger a move/operation and block until completion.
    void
    moveToIndex(int index)
     

  • Method Details

    • asynchronousMoveToDefined

      void asynchronousMoveToDefined(String coordinatesName) throws DeviceException
      Trigger a move/operation to a pre-defined and indexed position and return immediately. Implementations of this method should be non-blocking to allow concurrent motion;
      Parameters:
      coordinatesName - Coordinates to move to
      Throws:
      DeviceException

    • asynchronousMoveToIndex

      void asynchronousMoveToIndex(int index) throws DeviceException
      Throws:
      DeviceException

    • getDefinedCoordinatesNames

      Set<String> getDefinedCoordinatesNames()
      Returns an array of the names of registered defined coordinates
      Returns:
      an array of defined coordinates names

    • isAt

      boolean isAt(String coordinatesToTest) throws DeviceException
      Tests if the coordinates are at (or if appropriate, close to) the values in coordinatesToTest.
      Parameters:
      coordinatesToTest - The position to compare the positioner's position to.
      Returns:
      true if coordinates is at coordinatesToTest
      Throws:
      DeviceException

    • isAtIndex

      boolean isAtIndex(int indexToTest) throws DeviceException
      Throws:
      DeviceException

    • moveToDefined

      void moveToDefined(String coordinatesName) throws DeviceException
      Trigger a move/operation and block until completion.
      Parameters:
      coordinatesName - Coordinates to move to
      Throws:
      DeviceException

    • moveToIndex

      void moveToIndex(int index) throws DeviceException
      Throws:
      DeviceException