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. Holds an instance of ShutterStatus internally.

Author:

tether

See Also:

ShutterStatus

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, ShutterStatus status) Constructs from a sequence number and a ShutterStatus value.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Puts the sequence number into a data buffer.
ShutterStatus.AxisStatus	getAxisStatus(Axis ax) Forwarded to the internal ShutterStatus instance.
int	getMotionProfile() Forwarded to the internal ShutterStatus instance.
int	getSmState() Forwarded to the internal ShutterStatus instance.
ShutterStatus	getStatusBusMessage() Gets the object that can be transmitted on the CCS status bus.
boolean	isCalibrated() Forwarded to the internal ShutterStatus instance.
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,
                        ShutterStatus status)

Constructs from a sequence number and a ShutterStatus value.

Parameters:

sequence - A message sequence number.

status - A ShutterStatus value

See Also:

ShutterStatus

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.

getStatusBusMessage

public ShutterStatus getStatusBusMessage()

Gets the object that can be transmitted on the CCS status bus.

Returns:

The internal instance of ShutterStatus.

getMotionProfile

public int getMotionProfile()

Forwarded to the internal ShutterStatus instance.

Returns:

isCalibrated

public boolean isCalibrated()

Forwarded to the internal ShutterStatus instance.

Returns:

getSmState

public int getSmState()

Forwarded to the internal ShutterStatus instance.

Returns:

getAxisStatus

public ShutterStatus.AxisStatus getAxisStatus(Axis ax)

Forwarded to the internal ShutterStatus instance.

Returns:

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