org.lsst.ccs.bus.messages

Class StatusMessage<T extends Serializable,D>

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage<T,D>

org.lsst.ccs.bus.messages.StatusMessage<T,D>

Type Parameters:

T - Any Serializable class embedded in the StatusMessage

D - The class of the encoded object.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AlarmClear, MetadataStatus, StateChangeNotification, StatusAlert, StatusConfigurationInfo, StatusData, StatusHeartBeat

public abstract class StatusMessage<T extends Serializable,D>
extends BusMessage<T,D>

Base class for all messages sent on the Status Bus. All StatusMessage objects contain the internal state of the Agent from which they originated at the time of publication. The default encoding for StatusMessages breaks down the embedded object in key-value pairs (and possibly timestamp) and returns the DataList object containing them. Subclasses can change this default encoding behavior. Please refer to their documentation for further details on their encoding strategy.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusMessage(T obj, StateBundle state) Build a StatusMessage from the provided Object.

Method Summary

Modifier and Type	Method and Description
byte[]	getSerializedObject() Deprecated.
StateBundle	getState() Get the published State object that contains the Agent's internal state at the moment the StatusMessage was published.
void	setState(StateBundle state) Deprecated.
String	toString()

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

encodeObject, getClassName, getEncodedData, getObject, getOriginAgentInfo, getTimeStamp, setOriginAgentInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusMessage

public StatusMessage(T obj,
                     StateBundle state)

Build a StatusMessage from the provided Object.

Parameters:

obj - The Serializable object to be sent over the buses.

state - The State of the Agent at the time the object is created.

Method Detail

setState

@Deprecated
public void setState(StateBundle state)

Deprecated.

Set the StateBundle object containing the Agent's internal state at the moment the StatusMessage was published. This method should be only used by the framework. REVIEW: can the state be provided at creation?

Parameters:

state - The StateBundle object.

getSerializedObject

@Deprecated
public byte[] getSerializedObject()

Deprecated.

Overrides:

getSerializedObject in class BusMessage<T extends Serializable,D>

getState

public StateBundle getState()

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

Returns:

The StateBundle object.

toString

public String toString()

Overrides:

toString in class BusMessage<T extends Serializable,D>