org.lsst.ccs.subsystem.shutter.common

Class HallTransition

java.lang.Object

org.lsst.ccs.subsystem.shutter.common.HallTransition

All Implemented Interfaces:

Serializable, Comparable<TimeOrdered>, TimeOrdered

public final class HallTransition
extends Object
implements Serializable, TimeOrdered

Immutable class containing the data for a transition of a Hall sensor.

Author:

Owen Saxton, tether

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HallTransition(org.lsst.ccs.utilities.taitime.CCSTimeStamp time, int sensor, double position, boolean on) Full constructor.

Method Summary

Modifier and Type	Method and Description
double	getPosition() Gets the absolute position of the transition.
int	getSensorId() Gets the Hall sensor ID number.
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getTime() Gets the time of the transition.
boolean	isOn() Gets the polarity of the Hall transition.

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

HallTransition

public HallTransition(org.lsst.ccs.utilities.taitime.CCSTimeStamp time,
                      int sensor,
                      double position,
                      boolean on)

Full constructor.

Parameters:

time - The time of the transition.

sensor - The ID number of the sensor.

position - The encoder position in mm assigned to the transition, derived from the last calibration of the Hall sensor readout.

on - True if the transition left the Hall switch in the "on" state.

Method Detail

getTime

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

Gets the time of the transition.

Specified by:

getTime in interface TimeOrdered

Returns:

the transition time.

getSensorId

public int getSensorId()

Gets the Hall sensor ID number.

Returns:

the ID number

getPosition

public double getPosition()

Gets the absolute position of the transition.

Returns:

the absolute position in mm

isOn

public boolean isOn()

Gets the polarity of the Hall transition.

Returns:

true if the transition was from off to on, else false.