org.lsst.ccs.subsystems.shutter.common

Class MovementHistory

java.lang.Object

org.lsst.ccs.subsystems.shutter.common.MovementHistory

All Implemented Interfaces:

Serializable

public final class MovementHistory
extends Object
implements Serializable

Immutable class containing the data produced by a blade set move.

Author:

Owen Saxton, tether

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MovementHistory(ShutterSide side, int status, long startTime, double startPosition, long endTime, double endPosition, List<BladePosition> positions, List<HallTransition> transitions) Constructs an instance from the individual field values.

Method Summary

Modifier and Type	Method and Description
double	getEndPosition() Gets the position at the end of the movement.
long	getEndTime() Gets the end time of the movement in Epoch microseconds.
List<HallTransition>	getHallTransitions() Gets the time-ordered list of Hall Sensor transitions generated by this movement.
List<BladePosition>	getPositions() Gets a time-ordered list of BladePositions generated by the move.
ShutterSide	getSide() Gets the side of the camera X axis to which the blade set belongs.
double	getStartPosition() Gets the position at the beginning of the movement.
long	getStartTime() Gets the start time of the movement in Epoch microseconds.
int	getStatus() Gets the movement completion status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MovementHistory

public MovementHistory(ShutterSide side,
                       int status,
                       long startTime,
                       double startPosition,
                       long endTime,
                       double endPosition,
                       List<BladePosition> positions,
                       List<HallTransition> transitions)

Constructs an instance from the individual field values.

Parameters:

side - the side of the camera X axis to which the blade set belongs.

status - the status code from the move. See org.lsst.ccs.subsystems.shutter.driver.MovementStatus

startTime - the start time of the move, a system time stamp in microseconds

startPosition - the initial relative position

endTime - the end time of the move in microseconds

endPosition - the final relative position

positions - the blade position info sampled during the move

transitions - the Hall transitions that occurred during the move

Method Detail

getSide

public ShutterSide getSide()

Gets the side of the camera X axis to which the blade set belongs.

Returns:

the side

getStatus

public int getStatus()

Gets the movement completion status.

Returns:

the status code

getStartTime

public long getStartTime()

Gets the start time of the movement in Epoch microseconds.

Returns:

the start time

getEndTime

public long getEndTime()

Gets the end time of the movement in Epoch microseconds.

Returns:

the end time

getStartPosition

public double getStartPosition()

Gets the position at the beginning of the movement.

Returns:

the start position, a number in [0,1]

getEndPosition

public double getEndPosition()

Gets the position at the end of the movement.

Returns:

the end position, a number in [0,1]

getPositions

public List<BladePosition> getPositions()

Gets a time-ordered list of BladePositions generated by the move.

Returns:

the unmodifiable list of positions

getHallTransitions

public List<HallTransition> getHallTransitions()

Gets the time-ordered list of Hall Sensor transitions generated by this movement.

Returns:

the unmodifiable list of transitions