org.lsst.ccs.subsystem.shutter.status

Class ShutterStatus

java.lang.Object

org.lsst.ccs.subsystem.shutter.status.ShutterStatus

All Implemented Interfaces:

Serializable

public final class ShutterStatus
extends Object
implements Serializable

Holds a ShutterStatus message sent from the PLC. Immutable.

Author:

tether

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShutterStatus.AxisStatus Holds the status report for a single axis in a ShutterStatus message.

Constructor Summary

Constructors

Constructor and Description
ShutterStatus(int motionProfile, boolean isCalibrated, int smState, Map<ShutterSide,ShutterStatus.AxisStatus> axes) Constructs from scratch.

Method Summary

Modifier and Type	Method and Description
ShutterStatus.AxisStatus	getAxisStatus(ShutterSide side) Gets the status info for one of the blade set axes.
int	getMotionProfile() Gets the motion profile in use
int	getSmState() Gets the current state for the shutter controller's state machine.
boolean	isCalibrated() Is a good calibration in effect?
String	toString() Creates a string of the format 'ShutterStatus{fieldName=value, ..., axstatus[PLUSX]= AxisStatus{...}, axstatus[MINUSX]=AxisStatus{...}}'.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShutterStatus

public ShutterStatus(int motionProfile,
                     boolean isCalibrated,
                     int smState,
                     Map<ShutterSide,ShutterStatus.AxisStatus> axes)

Constructs from scratch.

Parameters:

motionProfile - The index number of the motion profile in effect.

isCalibrated - Is the shutter properly calibrated?

smState - The current state of the PLC state machine.

axes - The source of the AxisStatus values to be stored in this message.

Method Detail

getMotionProfile

public int getMotionProfile()

Gets the motion profile in use

Returns:

The integer index of the motion profile.

isCalibrated

public boolean isCalibrated()

Is a good calibration in effect?

Returns:

true if it is, else false.

getSmState

public int getSmState()

Gets the current state for the shutter controller's state machine.

Returns:

The integer state index.

getAxisStatus

public ShutterStatus.AxisStatus getAxisStatus(ShutterSide side)

Gets the status info for one of the blade set axes.

Parameters:

side - The side whose status info is wanted.

Returns:

The AxisStatus object for the given blade set.

toString

public String toString()

Creates a string of the format 'ShutterStatus{fieldName=value, ..., axstatus[PLUSX]= AxisStatus{...}, axstatus[MINUSX]=AxisStatus{...}}'.

Overrides:

toString in class Object

Returns:

The created string.