org.lsst.ccs.subsystem.shutter.plc

Class MsgToCCS

java.lang.Object

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

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

Direct Known Subclasses:

CalibDone, Disable, Enable, Error, Ignored, MotionDonePLC, ShutterStatusPLC, Timer

public abstract class MsgToCCS
extends PLCMsg

The base class for all messages sent from the PLC task to CCS. It supplies a sequence number field that PLC code uses to ensure that ADS notifications get generated when needed.

Author:

tether

Field Summary

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

MESSAGE_SET_VERSION

Constructor Summary

Constructors

Constructor and Description
MsgToCCS(ByteBuffer data) Gets the sequence number from a byte buffer.
MsgToCCS(int sequence) Saves the sequence number.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Puts the sequence number into a data buffer.
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

MsgToCCS

public MsgToCCS(int sequence)

Saves the sequence number.

Parameters:

sequence - The sequence number.

MsgToCCS

public MsgToCCS(ByteBuffer data)

Gets the sequence number from a byte buffer.

Parameters:

data - The data buffer.

Method Detail

encode

public void encode(ByteBuffer data)

Puts the sequence number into a data buffer.

Overrides:

encode in class PLCMsg

Parameters:

data - The buffer.

toString

public String toString()

Description copied from class: PLCMsg

Converts the message to a readable string.

Overrides:

toString in class PLCMsg

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