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 suitable for trending. Immutable.

Note that booleans and enumerations are stored as ints since those data types were not trendable at the time this code was written. For the same reason CCSTimeStamps are stored as the double values gotten from CCSTimeStamp.getTAIDouble().

Author:

tether

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShutterStatus.ShutterAxisStatus 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.ShutterAxisStatus> axes, boolean isSafetyOn, Map<RTD,Double> temperature, Map<RTD,Boolean> tempIsSafe, boolean brakePowerIsOn, org.lsst.ccs.utilities.taitime.CCSTimeStamp creationTime, PtpDeviceState ptpState, int leapSeconds, boolean leapIsValid) Constructs from scratch.

Method Summary

Modifier and Type	Method and Description
boolean	brakePowerIsOn() Gets the subsystems current knowledge of the state of brake power.
ShutterStatus.ShutterAxisStatus	getAxisStatus(ShutterSide side) Gets the status info for one of the blade set axes.
double	getCreationTime() Gets the creation time stamp.
int	getLeapSeconds()
int	getMotionProfile() Gets the motion profile in use
PtpDeviceState	getPtpState() Gets the state of the EL6688 PTP device.
int	getPtpStateAsInt() Gets the state of the EL6688 PTP device.
int	getSmState() Gets the current state for the shutter controller's state machine.
Map<RTD,Double>	getTemperature() Gets the map of three RTD temperatures in degrees C.
Map<RTD,Boolean>	getTempIsSafe() Gets the map of temperature-is-safe flags for the RTDs.
boolean	isCalibrated() Is a good calibration in effect?
boolean	isLeapValid()
boolean	isSafetyOn() Are safety checks in effect?
String	toString() Creates a string of the format 'ShutterStatus{fieldName=value, ..., axstatus[PLUSX]= ShutterAxisStatus{...}, axstatus[MINUSX]=ShutterAxisStatus{...}}'.

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.ShutterAxisStatus> axes,
                     boolean isSafetyOn,
                     Map<RTD,Double> temperature,
                     Map<RTD,Boolean> tempIsSafe,
                     boolean brakePowerIsOn,
                     org.lsst.ccs.utilities.taitime.CCSTimeStamp creationTime,
                     PtpDeviceState ptpState,
                     int leapSeconds,
                     boolean leapIsValid)

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 ShutterAxisStatus values to be stored in this message.

isSafetyOn - Are shutter hardware safety checks enabled in the PLC?

temperature - The RTD temperatures in degrees Celsius.

tempIsSafe - The RTD temperature-in-safe-range flags.

brakePowerIsOn - True if and only if 24V power is on as far as this subsystem knows.

creationTime - The time at which this message was created.This will be the time recorded in the original message from the PLC or the current system time if the subsystem is updating it with information that didn't come from the PLC, such as brake power info.

ptpState - The state of the EL6688 PTP device.

leapSeconds - The current number of leap seconds.

leapIsValid - True if and only if the leap second count is valid.

Throws:

IllegalArgumentException - if either the temperature list or the tempIsSafe list is null or is not of size 3.

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.ShutterAxisStatus 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 ShutterAxisStatus object for the given blade set.

isSafetyOn

public boolean isSafetyOn()

Are safety checks in effect?

Returns:

true if they are, else false.

getTemperature

public Map<RTD,Double> getTemperature()

Gets the map of three RTD temperatures in degrees C.

Returns:

A new map indexed by RTD enumerator.

getTempIsSafe

public Map<RTD,Boolean> getTempIsSafe()

Gets the map of temperature-is-safe flags for the RTDs.

Returns:

A new map indexed by RTD enumerator.

brakePowerIsOn

public boolean brakePowerIsOn()

Gets the subsystems current knowledge of the state of brake power.

Returns:

The brake-power-is-on flag.

getCreationTime

public double getCreationTime()

Gets the creation time stamp.

Returns:

The TAI time as a double.

getPtpState

public PtpDeviceState getPtpState()

Gets the state of the EL6688 PTP device.

Returns:

The state (as an enumeration).

getPtpStateAsInt

public int getPtpStateAsInt()

Gets the state of the EL6688 PTP device.

Returns:

The state (as an integer).

getLeapSeconds

public int getLeapSeconds()

isLeapValid

public boolean isLeapValid()

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

The created string.