org.lsst.ccs.bus.messages

Class StatusStateChangeNotification

java.lang.Object

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

org.lsst.ccs.bus.messages.StatusMessage<StateBundle,Object>

org.lsst.ccs.bus.messages.StatusStateChangeNotification

All Implemented Interfaces:

Serializable

public final class StatusStateChangeNotification
extends StatusMessage<StateBundle,Object>

A StatusChangeNotification for State changes. This is an event driven message sent on the Status bus when a State change occurs. It contains the new (current) state of the subsystem and the old one.

Author:

The LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusStateChangeNotification(StateBundle oldState, StateBundle newState) Create a StatusStateChangeNotification object.

Method Summary

Modifier and Type	Method and Description
protected Object	encodeObject(StateBundle obj) Subclasses must provide a specific implementation of the encoding process.
StateBundle	getNewState() Get the new state of the Agent.
StateBundle	getOldState() Get the old state of the Agent.

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

getState, toString

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

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

StatusStateChangeNotification

public StatusStateChangeNotification(StateBundle oldState,
                                     StateBundle newState)

Create a StatusStateChangeNotification object.

Parameters:

oldState - The old state before the State change

newState - The new state, i.e. the current Agent state.

Method Detail

getNewState

public StateBundle getNewState()

Get the new state of the Agent.

Returns:

The new state of the Agent.

getOldState

public StateBundle getOldState()

Get the old state of the Agent.

Returns:

The old state of the Agent.

encodeObject

protected Object encodeObject(StateBundle obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<StateBundle,Object>

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.