org.lsst.ccs.subsystem.shutter.plc

Class Ignored

java.lang.Object

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

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

org.lsst.ccs.subsystem.shutter.plc.Ignored

public class Ignored
extends MsgToCCS

Holds an Ignored message from the PLC.

Author:

tether

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ignored.Reason The set of possible reasons for the PLC sending the Ignored message.

Field Summary

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

MESSAGE_SET_VERSION

Constructor Summary

Constructors

Constructor and Description
Ignored(ByteBuffer data) Reads and converts the PLC form of the message.
Ignored(int sequence, Ignored.Reason reason) Constructs from scratch.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Puts the sequence number into a data buffer.
Ignored.Reason	getReason() Gets the reason why the PLC ignored one of out messages.
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

Ignored

public Ignored(int sequence,
               Ignored.Reason reason)

Constructs from scratch.

Parameters:

sequence - A message sequence number.

reason - The reason why the PLC code ignored an event message.

Ignored

public Ignored(ByteBuffer data)

Reads and converts the PLC form of the message.

Parameters:

data - Holds the PLC message data.

Method Detail

getReason

public Ignored.Reason getReason()

Gets the reason why the PLC ignored one of out messages.

Returns:

The reason enumerator.

See Also:

Ignored.Reason

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.

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