org.lsst.ccs.subsystems.shutter.common

Interface BladeSet

All Known Implementing Classes:

BladeSetDrvr, BladeSetSimulator

public interface BladeSet

The interface to software controlling a single blade set, real or simulated.

Author:

tether

Method Summary

Modifier and Type	Method and Description
BladeSetConfiguration	getBladeSetConfiguration() Gets the configuration of the BladeSet.
double	getCurrentPosition() Gets the current position of the BladeSet.
int	getIndex() Gets the index of the blade set.
default void	init() Initializes any underlying hardware, etc.
MovementHistory	moveToPosition(double position, double moveTime) Moves the blade set to the specified position.

Method Detail

getCurrentPosition

double getCurrentPosition()

Gets the current position of the BladeSet. May cause hardware operations.

Returns:

the current relative position of the blade set

See Also:

BladePosition

moveToPosition

MovementHistory moveToPosition(double position,
                               double moveTime)

Moves the blade set to the specified position. May cause hardware operations.

Parameters:

position - the desired relative position of the leading edge of the blade set

moveTime - the move duration in seconds

Returns:

a MovementHistory instance resulting from the motion

Upon return getCurrentPosition() will reflect the final position of the move in any thread.

Throws:

IllegalArgumentException - if position is not valid

getIndex

int getIndex()

Gets the index of the blade set. The index specifies which physical blade set this object represents.

Returns:

the index (0 or 1)

getBladeSetConfiguration

BladeSetConfiguration getBladeSetConfiguration()

Gets the configuration of the BladeSet.

Returns:

the BladeSet configuration

init

default void init()

Initializes any underlying hardware, etc. The default is to do nothing.