org.lsst.ccs.bus.messages

Class StatusData<T extends Serializable>

java.lang.Object

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

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

org.lsst.ccs.bus.messages.StatusData<T>

Type Parameters:

T - Any Serializable class embedded in the StatusData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

StatusRuntimeInfo, StatusSubsystemData

public class StatusData<T extends Serializable>
extends StatusMessage<T,KeyValueDataList>

Base class for all status messages containing data that is meant to be stored in the trending database. The provided Serializable object is embedded within the StatusData object and encoded into the corresponding DataList.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected KeyValueDataList	encodeObject(T obj) Subclasses must provide a specific implementation of the encoding process.
KeyValueDataList	getEncodedData() Get the Encoded version of the embedded Object.

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

getSerializedObject, getState, setState, toString

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

getClassName, getObject, getOriginAgentInfo, getTimeStamp, setOriginAgentInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusData

public StatusData(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

encodeObject

protected KeyValueDataList encodeObject(T obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<T extends Serializable,KeyValueDataList>

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.

getEncodedData

public KeyValueDataList getEncodedData()

Description copied from class: BusMessage

Get the Encoded version of the embedded Object.

Overrides:

getEncodedData in class BusMessage<T extends Serializable,KeyValueDataList>

Returns:

The Encoded version of the embedded Object.