org.lsst.ccs.subsystem.shutter.plc

Class ShutterStatus

java.lang.Object

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

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

org.lsst.ccs.subsystem.shutter.plc.ShutterStatus

All Implemented Interfaces:

Serializable

public class ShutterStatus
extends MsgToCCS
implements Serializable

Holds a ShutterStatus message sent from the PLC.

Author:

tether

See Also:

Serialized Form

Field Summary

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

MESSAGE_SET_VERSION

Constructor Summary

Constructors

Constructor and Description
ShutterStatus(ByteBuffer data) Reads and converts the PLC form of the message.
ShutterStatus(int sequence, int motionProfile, boolean isCalibrated, int smState, Supplier<AxisStatus> axes) Constructs from scratch.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Puts the sequence number into a data buffer.
AxisStatus	getAxisStatus(Axis ax)
int	getMotionProfile()
int	getSmState()
boolean	isCalibrated()
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

ShutterStatus

public ShutterStatus(int sequence,
                     int motionProfile,
                     boolean isCalibrated,
                     int smState,
                     Supplier<AxisStatus> axes)

Constructs from scratch.

Parameters:

sequence - A message sequence number.

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.

ShutterStatus

public ShutterStatus(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()

isCalibrated

public boolean isCalibrated()

getSmState

public int getSmState()

getAxisStatus

public AxisStatus getAxisStatus(Axis ax)

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, ...}