org.lsst.ccs.bus.messages

Class StatusSubsystemData

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

org.lsst.ccs.bus.messages.StatusSubsystemData

All Implemented Interfaces:

Serializable

public final class StatusSubsystemData
extends StatusData

Base class for all status messages containing data that is private to the sender Subsystem. Because clients will not necessarily have the class definition for the embedded object, this class relies on the encoding procedure of the embedded object.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusSubsystemData(KeyValueData kvData, StateBundle state) Build a StatusMessage from the provided Object.

Method Summary

Modifier and Type	Method and Description
String	getDataKey() Get the Key of the embedded object.
KeyValueData	getSubsystemData() Get the embedded subsystem data.

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

encodeObject, getEncodedData

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

getState, 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

StatusSubsystemData

public StatusSubsystemData(KeyValueData kvData,
                           StateBundle state)

Build a StatusMessage from the provided Object.

Parameters:

kvData - The KeyValue object to be sent over the buses.

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

Method Detail

getDataKey

public String getDataKey()

Get the Key of the embedded object. If the embedded object is a KeyValueData, then the KeyValueData's key is returned, otherwise the canonical name of the class of the embedded object.

Returns:

The key of the embedded object.

getSubsystemData

public KeyValueData getSubsystemData()

Get the embedded subsystem data.

Returns:

The subsystem data embedded in this message.

Throws:

EmbeddedObjectDeserializationException - if the embedded object cannot be deserialized.