org.lsst.ccs.subsystem.shutter.plc

Class Error

java.lang.Object

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

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

org.lsst.ccs.subsystem.shutter.plc.Error

public class Error
extends MsgToCCS

Holds an Error message sent from the PLC.

Author:

tether

Field Summary

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

MESSAGE_SET_VERSION

Constructor Summary

Constructors

Constructor and Description
Error(ByteBuffer data) Reads and converts the PLC form of the message.
Error(int sequence, Set<PLCError> errors) Constructs from scratch.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Puts the message into a data buffer.
Set<PLCError>	getErrors() Gets the set of errors that this message is reporting.
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

Error

public Error(int sequence,
             Set<PLCError> errors)

Constructs from scratch.

Parameters:

sequence - A message sequence number.

errors - The set of errors.

Error

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

Puts the message into a data buffer.

Overrides:

encode in class MsgToCCS

Parameters:

data - The buffer.

getErrors

public Set<PLCError> getErrors()

Gets the set of errors that this message is reporting.

Returns:

The unmodifiable set.

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