org.lsst.ccs.subsystem.shutter.plc

Class ShutterStatusPLC

java.lang.Object

org.lsst.ccs.subsystem.shutter.plc.PLCMsg

org.lsst.ccs.subsystem.shutter.plc.MsgToCCS

org.lsst.ccs.subsystem.shutter.plc.ShutterStatusPLC

public class ShutterStatusPLC
extends MsgToCCS

Holds a ShutterStatusPLC message sent from the PLC.

Author:

tether

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class org.lsst.ccs.subsystem.shutter.plc.PLCMsg

MESSAGE_SET_VERSION

Constructor Summary

Constructors

Constructor and Description
ShutterStatusPLC(ByteBuffer data) Reads and converts the PLC form of the message.
ShutterStatusPLC(int sequence, int motionProfile, boolean isCalibrated, int smState, Map<ShutterSide,ShutterStatusPLC.AxisStatusPLC> axstatus, boolean isSafetyOn, List<Integer> temperature) Constructs from a sequence number and field values.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Puts the sequence number into a data buffer.
ShutterStatusPLC.AxisStatusPLC	getAxisStatus(ShutterSide side) Gets the AxisStatusPLC value for the given side.
int	getMotionProfile() Gets the motion profile number.
int	getSmState() Returns the state of the PLC state machine.
List<Integer>	getTemperature() Gets the RTD readouts.
boolean	isCalibrated() Is the shutter calibrated?
boolean	isSafetyOn() Are the safety checks on?
String	toString() Converts the message to a readable string.

Methods inherited from class org.lsst.ccs.subsystem.shutter.plc.PLCMsg

getVersion, messageVersionIsBad

Methods inherited from class java.lang.Object

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

Constructor Detail

ShutterStatusPLC

public ShutterStatusPLC(int sequence,
                        int motionProfile,
                        boolean isCalibrated,
                        int smState,
                        Map<ShutterSide,ShutterStatusPLC.AxisStatusPLC> axstatus,
                        boolean isSafetyOn,
                        List<Integer> temperature)

Constructs from a sequence number and field values.

Parameters:

sequence - A message sequence number.

motionProfile - the motion profile number.

isCalibrated - Is the shutter calibrated?

smState - the state of the PLC state machine.

axstatus - the two axis status objects, one per side.

isSafetyOn - Are the safety checks in effect?

temperature - the RTD readout values.

ShutterStatusPLC

public ShutterStatusPLC(ByteBuffer data)

Reads and converts the PLC form of the message.

Parameters:

data - Holds the PLC message data.

Method Detail

encode

public void encode(ByteBuffer data)

Description copied from class: MsgToCCS

Puts the sequence number into a data buffer.

Overrides:

encode in class MsgToCCS

Parameters:

data - The buffer.

getMotionProfile

public int getMotionProfile()

Gets the motion profile number.

Returns:

The number.

isCalibrated

public boolean isCalibrated()

Is the shutter calibrated?

Returns:

getSmState

public int getSmState()

Returns the state of the PLC state machine.

Returns:

The state number.

getAxisStatus

public ShutterStatusPLC.AxisStatusPLC getAxisStatus(ShutterSide side)

Gets the AxisStatusPLC value for the given side.

Returns:

The axis status object.

isSafetyOn

public boolean isSafetyOn()

Are the safety checks on?

Returns:

true if the checks are one, else false.

getTemperature

public List<Integer> getTemperature()

Gets the RTD readouts.

Returns:

the three RTD values.

toString

public String toString()

Description copied from class: PLCMsg

Converts the message to a readable string.

Overrides:

toString in class MsgToCCS

Returns:

The string form of the message. The short message class name will come first followed by the field names and values enclosed in curly braces. For example, if message Foo is sent from CCS to the PLC it will inherit from MsgToPLC and look something like this: FooMessage{MsgToPLC{PLCMsg{...} ...} field1=val1, ...}