org.lsst.ccs.drivers.rotator

Interface RotatorInterface

All Known Implementing Classes:

RotatorDriver

public interface RotatorInterface

Methods to be implemented by the driver. This is based on the functionality documented in the SAL interface which is here: https://github.com/lsst-ts/ts_xml/tree/develop/sal_interfaces/Rotator

Author:

tonyj

Method Summary

Modifier and Type	Method and Description
void	addPositionListener(PositionListener positionListener)
void	addStateChangeListener(RotatorStateChangeListener stateChangeListener)
void	clearError() Clear the Fault state, sending the controller into Offline substate PublishOnly.You must use the engineering user interface to transition from that to Offline substate Available before the CSC can control the rotator.
void	configureAcceleration(double aLimit) Limit the minimum and maximum acceleration level of the rotator to be set within the global limit of +/- 1 deg/s2.
void	configureVelocity(double vLimit) The configure Velocity command limits the minimum and maximum velocity level of the rotator to be set within the global limit of +/- 3.5 deg/s.
void	move(double position) Move the rotator to the specified position and stop.During the move the enabled substate will be MovingPointToPoint, then it will return to Stationary.
void	removePositionListener(PositionListener positionListener)
void	removeStateChangeListener(RotatorStateChangeListener stateChangeListener)
void	stop() Stop any current rotation.

Method Detail

move

void move(double position)
   throws org.lsst.ccs.drivers.commons.DriverException,
          TimeoutException

Move the rotator to the specified position and stop.During the move the enabled substate will be MovingPointToPoint, then it will return to Stationary.

Parameters:

position - The target position in degrees

Throws:

org.lsst.ccs.drivers.commons.DriverException

TimeoutException

stop

void stop()
   throws org.lsst.ccs.drivers.commons.DriverException,
          TimeoutException

Stop any current rotation.

Throws:

org.lsst.ccs.drivers.commons.DriverException

TimeoutException

configureAcceleration

void configureAcceleration(double aLimit)
                    throws org.lsst.ccs.drivers.commons.DriverException,
                           TimeoutException

Limit the minimum and maximum acceleration level of the rotator to be set within the global limit of +/- 1 deg/s2.

Parameters:

aLimit -

Throws:

org.lsst.ccs.drivers.commons.DriverException

TimeoutException

configureVelocity

void configureVelocity(double vLimit)
                throws org.lsst.ccs.drivers.commons.DriverException,
                       TimeoutException

The configure Velocity command limits the minimum and maximum velocity level of the rotator to be set within the global limit of +/- 3.5 deg/s.

Parameters:

vLimit -

Throws:

org.lsst.ccs.drivers.commons.DriverException

TimeoutException

clearError

void clearError()
         throws org.lsst.ccs.drivers.commons.DriverException,
                TimeoutException

Clear the Fault state, sending the controller into Offline substate PublishOnly.You must use the engineering user interface to transition from that to Offline substate Available before the CSC can control the rotator.

Throws:

org.lsst.ccs.drivers.commons.DriverException

TimeoutException

addStateChangeListener

void addStateChangeListener(RotatorStateChangeListener stateChangeListener)

removeStateChangeListener

void removeStateChangeListener(RotatorStateChangeListener stateChangeListener)

addPositionListener

void addPositionListener(PositionListener positionListener)

removePositionListener

void removePositionListener(PositionListener positionListener)