org.lsst.ccs.subsystems.shutter.common

Class BladeSetCalibration.Item

java.lang.Object

org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration.Item

Enclosing class:

BladeSetCalibration

public static final class BladeSetCalibration.Item
extends Object

Inner class to hold a single blade calibration data item, corresponding to a change of state, or transition, of a Hall sensor. Immutable.

Constructor Summary

Constructors

Constructor and Description
Item(int sensor, int index, double position, boolean open, boolean reverse) Constructs a single calibration item from the field values.

Method Summary

Modifier and Type	Method and Description
int	getIndex() Gets the index used to distinguish members of a set of consecutive transitions.
double	getPosition() Gets the absolute position of the transition.
int	getSensor() Gets the Hall sensor ID number.
boolean	isOpen() Gets the state of the Hall sensor after the transition.
boolean	isReverse() Gets the direction-of-motion flag for the transition.

Methods inherited from class java.lang.Object

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

Constructor Detail

Item

public Item(int sensor,
            int index,
            double position,
            boolean open,
            boolean reverse)

Constructs a single calibration item from the field values.

Parameters:

sensor - the Hall sensor ID number (0, 1, 2, ...)

index - used to number consecutive transition pairs (0, 1, 2, ...) for the same sensor. A new pair starts when the state changes to open.

position - the absolute position of the sensor involved (mm)

open - the state of the sensor after the transition. true when a magnet is not present

reverse - true if the blade set was being retracted when the transition occurred

Method Detail

getSensor

public int getSensor()

Gets the Hall sensor ID number.

Returns:

the ID number

getIndex

public int getIndex()

Gets the index used to distinguish members of a set of consecutive transitions.

Returns:

the index

getPosition

public double getPosition()

Gets the absolute position of the transition.

Returns:

the position

isOpen

public boolean isOpen()

Gets the state of the Hall sensor after the transition.

Returns:

the state

isReverse

public boolean isReverse()

Gets the direction-of-motion flag for the transition.

Returns:

the direction flag