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
double	absoluteToEncoder(double absolute) The inverse of encoderToAbsolute(double).
double	absoluteToRelative(double abs) Converts an absolute position along the camera X axis to a relative blade set position in the range [0.0, 1.0], where 0.0 means fully retracted (open) and 1.0 means fully extended (closed).
double	encoderToAbsolute(double encoderValue) Converts a motor position encoder value to an absolute position in mm of the leading edge of the blade set on the camera X axis.
BladeSetConfiguration	getBladeSetConfiguration() Gets the configuration of the BladeSet.
double	getRelativePosition() Gets the current position of the BladeSet.
ShutterSide	getSide() Gets the side of the shutter to which the blade set belongs.
boolean	isFullyExtended() Is the blade set fully extended? That is, is its absolute position within the shutter tolerance of the closed position?
boolean	isFullyRetracted() Is the blade set fully retracted? That is, is its absolute position within the shutter tolerance of the open position?
MovementHistory	moveToPosition(double position, double moveTime) Moves the blade set to the specified position.
double	relativeToAbsolute(double rel) The inverse of absoluteToRelative(double).

Method Detail

getRelativePosition

double getRelativePosition()

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

getSide

ShutterSide getSide()

Gets the side of the shutter to which the blade set belongs.

getBladeSetConfiguration

BladeSetConfiguration getBladeSetConfiguration()

Gets the configuration of the BladeSet.

Returns:

the BladeSet configuration

encoderToAbsolute

double encoderToAbsolute(double encoderValue)

Converts a motor position encoder value to an absolute position in mm of the leading edge of the blade set on the camera X axis.

Parameters:

encoderValue - the value read from the encoder.

Returns:

the absolute position in mm.

absoluteToEncoder

double absoluteToEncoder(double absolute)

The inverse of encoderToAbsolute(double).

Parameters:

absolute - the absolute position.

Returns:

the corresponding encoder value.

absoluteToRelative

double absoluteToRelative(double abs)

Converts an absolute position along the camera X axis to a relative blade set position in the range [0.0, 1.0], where 0.0 means fully retracted (open) and 1.0 means fully extended (closed). The formula used is relative = (absolute - absoluteOpen) / (absoluteClosed - absoluteOpen).

Parameters:

abs - the absolute position.

Returns:

the relative position.

See Also:

BladeSetConfiguration

relativeToAbsolute

double relativeToAbsolute(double rel)

The inverse of absoluteToRelative(double).

Parameters:

rel - the relative position.

Returns:

the absolute position.

See Also:

BladeSetConfiguration

isFullyRetracted

boolean isFullyRetracted()

Is the blade set fully retracted? That is, is its absolute position within the shutter tolerance of the open position?

Returns:

the answer.

See Also:

ShutterConfiguration, BladeSetConfiguration

isFullyExtended

boolean isFullyExtended()

Is the blade set fully extended? That is, is its absolute position within the shutter tolerance of the closed position?

Returns:

the answer.

See Also:

ShutterConfiguration, BladeSetConfiguration