org.lsst.ccs.subsystem.shutter.plc

Class MsgToPLC

java.lang.Object

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

org.lsst.ccs.subsystem.shutter.plc.MsgToPLC

Direct Known Subclasses:

Calibrate, ChangeAxisEnablePLC, ChangeBrakeState, ClearAllFaultsPLC, ClearAxisFaultsPLC, CloseShutter, DisableAllAxesPLC, EnableAllAxesPLC, GoToProd, HomeAxisPLC, MoveAxisAbsolutePLC, MoveAxisRelativePLC, OpenShutter, Reset, TakeExposure, ToggleSafetyCheck

public abstract class MsgToPLC
extends PLCMsg

The base class for all messages to be sent to the PLC. Includes the version field gotten from PLCMsg and all the identification fields for the message.

Author:

tether

Field Summary

Fields

Modifier and Type	Field and Description
static UUID	subsystemUUID The UUID to use in messages sent to the PLC.

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

MESSAGE_SET_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MsgToPLC() Sets the version and message identification fields of a message to be sent to the PLC.
protected	MsgToPLC(ByteBuffer data) Reads and converts the version and message identification fields of a PLC message.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Converts the message fields to PLC form and appends them to a byte buffer.
boolean	hasSameIdent(MsgToPLC other) Checks whether this instance and another of MsgToPLC have the same identification info.
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

Field Detail

subsystemUUID

public static final UUID subsystemUUID

The UUID to use in messages sent to the PLC. Reset each time the subsystem is started.

Constructor Detail

MsgToPLC

protected MsgToPLC()

Sets the version and message identification fields of a message to be sent to the PLC.

MsgToPLC

protected MsgToPLC(ByteBuffer data)

Reads and converts the version and message identification fields of a PLC message.

Parameters:

data - Hold the PLC message data.

Method Detail

encode

public void encode(ByteBuffer data)

Description copied from class: PLCMsg

Converts the message fields to PLC form and appends them to a byte buffer.

Overrides:

encode in class PLCMsg

Parameters:

data - Holds the PLC message data.

hasSameIdent

public boolean hasSameIdent(MsgToPLC other)

Checks whether this instance and another of MsgToPLC have the same identification info.

Parameters:

other - The other instance.

Returns:

true if all ident info is the same, else false.

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