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

Interface IndexPositioner

All Superinterfaces:

CoordinatesMove, IndexMove

All Known Subinterfaces:

Assembly, Beamline, Diffractometer, EndStation, Gonio, PlateLoader, SampleEnvironment

All Known Implementing Classes:

AbstractPlateLoader, AssemblyAdapter, AssemblyBase, DiffractometerBase, EndStationBase, GonioBase, PlateLoaderAdapter

public interface IndexPositioner
extends IndexMove, CoordinatesMove

Method Summary

Modifier and Type	Method	Description
void	addDefinedCoordinates(String name, int index, Coordinates coordinates)
boolean	isLockedToIndexPositions()	Tests if the underlying positioner is expected to only allow movements to the indexed positions.
void	setDefinedCoordinates(List<Coordinates> coords)
Coordinates	updateCoordinates(Coordinates coord)

Methods inherited from interface uk.ac.gda.component.model.api.CoordinatesMove

asynchronousMoveToCoordinates, checkMovementValid, getCurrentCoordinates, getDefinedCoordinates, moveToCoordinates

Methods inherited from interface uk.ac.gda.component.model.api.IndexMove

asynchronousMoveToDefined, asynchronousMoveToIndex, getDefinedCoordinatesNames, isAt, isAtIndex, moveToDefined, moveToIndex

Method Details

addDefinedCoordinates

void addDefinedCoordinates(String name,
 int index,
 Coordinates coordinates)
                    throws DeviceException

Throws:

DeviceException

isLockedToIndexPositions

boolean isLockedToIndexPositions()

Tests if the underlying positioner is expected to only allow movements to the indexed positions.

Returns:

true if implementer is locked to indexed positions only

setDefinedCoordinates

void setDefinedCoordinates(List<Coordinates> coords)
                    throws DeviceException

Throws:

DeviceException

updateCoordinates

Coordinates updateCoordinates(Coordinates coord)
                       throws DeviceException

Throws:

DeviceException