org.lsst.ccs.bus.messages

Class StatusCommandDictionary

java.lang.Object

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

org.lsst.ccs.bus.messages.StatusMessage<HashMap<String,org.lsst.ccs.command.Dictionary>,Object>

org.lsst.ccs.bus.messages.StatusCommandDictionary

All Implemented Interfaces:

Serializable

public final class StatusCommandDictionary
extends StatusMessage<HashMap<String,org.lsst.ccs.command.Dictionary>,Object>

StatusMessage dedicated to command dictionary publication. It contains a map of all the targets/dictionaries for a given agent. This object is published by the AgentCommandDictionaryService; consoles should listen to the STATUS bus for these publications.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusCommandDictionary(HashMap<String,org.lsst.ccs.command.Dictionary> dictionary, StateBundle state)

Method Summary

Modifier and Type	Method and Description
protected Object	encodeObject(HashMap<String,org.lsst.ccs.command.Dictionary> dictionary) Subclasses must provide a specific implementation of the encoding process.
HashMap<String,org.lsst.ccs.command.Dictionary>	getDictionary() Get the actual dictionary contained in this StatusMessage.

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

getState, toString

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

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

StatusCommandDictionary

public StatusCommandDictionary(HashMap<String,org.lsst.ccs.command.Dictionary> dictionary,
                               StateBundle state)

Method Detail

getDictionary

public HashMap<String,org.lsst.ccs.command.Dictionary> getDictionary()

Get the actual dictionary contained in this StatusMessage.

Returns:

The Map of targets/dictionaries.

encodeObject

protected Object encodeObject(HashMap<String,org.lsst.ccs.command.Dictionary> dictionary)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<HashMap<String,org.lsst.ccs.command.Dictionary>,Object>

Parameters:

dictionary - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.