org.lsst.ccs.subsystems.shutter.common

Class HallTransition

java.lang.Object

org.lsst.ccs.subsystems.shutter.common.HallTransition

All Implemented Interfaces:

Serializable

public final class HallTransition
extends Object
implements Serializable

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

Author:

Owen Saxton, tether

See Also:

BladePosition, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HallTransition(long time, int sensor, boolean open, boolean reverse, double position, double relPosition) Full constructor.

Method Summary

Modifier and Type	Method and Description
double	getPosition() Gets the absolute position of the transition.
double	getRelPosition() Gets the relative position of the transition.
int	getSensorId() Gets the Hall sensor ID number.
long	getTransitionTime() Gets the time of the transition.
boolean	isOpen() Is the new state of the sensor "open"?
boolean	isReverse() Was the blade set retracting when the transition occurred?

Methods inherited from class java.lang.Object

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

Constructor Detail

HallTransition

public HallTransition(long time,
                      int sensor,
                      boolean open,
                      boolean reverse,
                      double position,
                      double relPosition)

Full constructor.

Parameters:

time - The time of the transition, a system time in microseconds.

sensor - The ID number of the sensor.

open - Is the new state of the sensor "open"?

reverse - Was the blade set retracting?

position - The absolute position of the transition.

relPosition - The relative position of the transition.

Method Detail

getTransitionTime

public long getTransitionTime()

Gets the time of the transition.

Returns:

the transition time, a system time in microseconds

getSensorId

public int getSensorId()

Gets the Hall sensor ID number.

Returns:

the ID number

isOpen

public boolean isOpen()

Is the new state of the sensor "open"?

Returns:

the new-state flag

isReverse

public boolean isReverse()

Was the blade set retracting when the transition occurred?

Returns:

the retracting flag

getPosition

public double getPosition()

Gets the absolute position of the transition.

Returns:

the absolute position in mm

getRelPosition

public double getRelPosition()

Gets the relative position of the transition.

Returns:

the relative position