org.lsst.ccs.bus.messages

Class StatusData

java.lang.Object

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

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

org.lsst.ccs.bus.messages.StatusData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

StatusRuntimeInfo, StatusSubsystemData

public class StatusData
extends StatusMessage<KeyValueData,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

Field Summary

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

obj

Constructor Summary

Constructors

Constructor and Description
StatusData(KeyValueData obj) Build a StatusMessage from the provided Object.

Method Summary

Modifier and Type	Method and Description
protected KeyValueDataList	encodeObject(KeyValueData 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

getState, setState, toString

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

getCCSTimeStamp, getClassName, getDeserializationDuration, getDoneDeSerializationTime, getIncomingQueueInTimeStamp, getIncomingQueueOutTimeStamp, getObject, getOriginAgentInfo, getOutgoingQueueInTimeStamp, getOutgoingQueueOutTimeStamp, getSerializationDuration, getSerializationTime, getTransferDuration, setIncomingQueueInTimeStamp, setIncomingQueueOutTimeStamp, setOriginAgentInfo, setOutgoingQueueInTimeStamp, setOutgoingQueueOutTimeStamp, updateTimingInformation

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusData

public StatusData(KeyValueData obj)

Build a StatusMessage from the provided Object. This constructor is to be used to build a StatusData message that should not encode the provided object because the result of the encoding would yield the same object.

Parameters:

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

Method Detail

encodeObject

protected KeyValueDataList encodeObject(KeyValueData obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<KeyValueData,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<KeyValueData,KeyValueDataList>

Returns:

The Encoded version of the embedded Object.