org.lsst.ccs.bus.messages

Class StatusMessage

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage

org.lsst.ccs.bus.messages.StatusMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Alarm, AlarmClear, EncodedDataStatus, HeartBeatStatus, MetadataStatus, StateChangeNotification, StatusForEnd, StatusForStart

public class StatusMessage
extends BusMessage

Message to be sent on the Status Bus. Currently all Status messages contain an object that describes the internal state of the Agent from which the Status came from at the moment of the MessageStatus publication.

Author:

LSST CCS Team

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected PublishedState	state

Constructor Summary

Constructors

Constructor and Description
StatusMessage()

Method Summary

Modifier and Type	Method and Description
PublishedState	getState() Get the PublishedState object that contains the Agent's internal state at the moment the StatusMessage was published.
void	setState(PublishedState state) Set the PublishedState object containing the Agent's internal state at the moment the StatusMessage was published.
String	toString()

Methods inherited from class org.lsst.ccs.bus.messages.BusMessage

getOriginAgentInfo, getSummary, getTimeStamp, setOriginAgentInfo, setSummary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

state

protected PublishedState state

Constructor Detail

StatusMessage

public StatusMessage()

Method Detail

setState

public void setState(PublishedState state)

Set the PublishedState object containing the Agent's internal state at the moment the StatusMessage was published.

Parameters:

state - The PublishedState object.

getState

public PublishedState getState()

Get the PublishedState object that contains the Agent's internal state at the moment the StatusMessage was published.

Returns:

The PublishedState object.

toString

public String toString()

Overrides:

toString in class Object