org.lsst.ccs.subsystems.shutter.common

Class BladePosition

java.lang.Object

org.lsst.ccs.subsystems.shutter.common.BladePosition

All Implemented Interfaces:

Serializable

public final class BladePosition
extends Object
implements Serializable

Immutable class containing the data for a single blade position sample.

Blade set positions come in absolute and relative flavors. Absolute positions are in mm along an axis common to both blade sets with a single origin. Relative positions are dimensionless and use a separate axis for each blade set; 0.0 means fully retracted (open) and 1.0 means fully extended (closed). Each instance of this class contains both types of position.

Author:

Owen Saxton, tether

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BladePosition(double position, double relPosition) Constructs given the position values.
BladePosition(long time, double position, double relPosition) Constructs given all three values.

Method Summary

Modifier and Type	Method and Description
double	getPosition() Gets the sampled absolute position.
double	getRelPosition() Gets the relative position calculated from the absolute position.
long	getTime() Gets the time at which the position sample was taken..

Methods inherited from class java.lang.Object

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

Constructor Detail

BladePosition

public BladePosition(long time,
                     double position,
                     double relPosition)

Constructs given all three values.

Parameters:

time - a system time stamp (in microseconds)

position - the absolute position

relPosition - the relative position

BladePosition

public BladePosition(double position,
                     double relPosition)

Constructs given the position values. The time is taken as System.currentTimeMillis() * 1000.

Parameters:

position - the absolute position

relPosition - the relative position

Method Detail

getTime

public long getTime()

Gets the time at which the position sample was taken..

Returns:

the time value, a system time stamp in microseconds

getPosition

public double getPosition()

Gets the sampled absolute position.

Returns:

the absolute position

getRelPosition

public double getRelPosition()

Gets the relative position calculated from the absolute position.

Returns:

the relative position