org.lsst.ccs.subsystem.shutter.common

Class EncoderSample

java.lang.Object

org.lsst.ccs.subsystem.shutter.common.EncoderSample

All Implemented Interfaces:

Serializable, Comparable<TimeOrdered>, TimeOrdered

public final class EncoderSample
extends Object
implements Serializable, TimeOrdered

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

Author:

Owen Saxton, tether

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EncoderSample(org.lsst.ccs.utilities.taitime.CCSTimeStamp time, double position) Constructs from field values.

Method Summary

Modifier and Type	Method and Description
double	getPosition() Gets the sampled encoder position.
org.lsst.ccs.utilities.taitime.CCSTimeStamp	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

Methods inherited from interface org.lsst.ccs.subsystem.shutter.common.TimeOrdered

compareTo, timeDiff, timeDiff

Constructor Detail

EncoderSample

public EncoderSample(org.lsst.ccs.utilities.taitime.CCSTimeStamp time,
                     double position)

Constructs from field values.

Parameters:

time - the time at which the sample was taken.

position - the encoder position in mm.

Method Detail

getTime

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getTime()

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

Specified by:

getTime in interface TimeOrdered

Returns:

the time value, a CCS timestamp.

getPosition

public double getPosition()

Gets the sampled encoder position.

Returns:

the position in mm.