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

Field Summary

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

obj

Constructor Summary

Constructors

Constructor and Description
StatusStateChangeNotification(org.lsst.ccs.utilities.taitime.CCSTimeStamp stateTransitionTimestamp, StateBundle oldState, String cause) Create a StatusStateChangeNotification object.
StatusStateChangeNotification(org.lsst.ccs.utilities.taitime.CCSTimeStamp stateTransitionTimestamp, StateBundle oldState, String cause, boolean skipSerialization) 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.
String	getCause() Get the reason for this state transition.
StateBundle	getNewState() Get the new state of the Agent.
StateBundle	getOldState() Get the old state of the Agent.
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getStateTransitionTimestamp() Get the CCSTimeStamp of this state transition.

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

StatusStateChangeNotification

public StatusStateChangeNotification(org.lsst.ccs.utilities.taitime.CCSTimeStamp stateTransitionTimestamp,
                                     StateBundle oldState,
                                     String cause)

Create a StatusStateChangeNotification object.

Parameters:

cause - The reason the state transition happened.

stateTransitionTimestamp - The CCSTimeStamp corresponding to this state transition

oldState - The old state before the State change

StatusStateChangeNotification

public StatusStateChangeNotification(org.lsst.ccs.utilities.taitime.CCSTimeStamp stateTransitionTimestamp,
                                     StateBundle oldState,
                                     String cause,
                                     boolean skipSerialization)

Create a StatusStateChangeNotification object.

Parameters:

cause - The reason the state transition happened.

stateTransitionTimestamp - The CCSTimeStamp corresponding to this state transition

oldState - The old state before the State change

skipSerialization - do not serialize the object. This is to be true only for messages that are created on the client side during the preProcessBusMessage step.

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.

getStateTransitionTimestamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getStateTransitionTimestamp()

Get the CCSTimeStamp of this state transition.

Returns:

The CCSTimeStamp when the state transition occurred.

getCause

public String getCause()

Get the reason for this state transition.

Returns:

The reason for this state transition. Null if no reason was provided.