org.lsst.ccs.bus.messages

Class StatusRaisedAlert

java.lang.Object

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

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

org.lsst.ccs.bus.messages.StatusAlert<Alert,Alert>

org.lsst.ccs.bus.messages.StatusRaisedAlert

All Implemented Interfaces:

Serializable

public final class StatusRaisedAlert
extends StatusAlert<Alert,Alert>

Base class for all status messages containing an RaisedAlert. A RaisedAlert object is embedded within this StatusRaisedAlert. StatusRaisedAlert provides no encoding as the RaisedAlert object already encodes the original Alerts that triggered the publication.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusRaisedAlert(Alert alert, String cause, StateBundle state)
StatusRaisedAlert(Alert alert, String cause, StateBundle state, RaisedAlertSummary raisedAlertSummary) Build a StatusAlert from the provided RaisedAlert.

Method Summary

Modifier and Type	Method and Description
protected Alert	encodeObject(Alert obj) Subclasses must provide a specific implementation of the encoding process.
String	getCause() Get the String explaining what caused the Alert.
Alert	getRaisedAlert() Get the RaisedAlert contained in this message.

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

getRaisedAlertSummary

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

StatusRaisedAlert

public StatusRaisedAlert(Alert alert,
                         String cause,
                         StateBundle state)

StatusRaisedAlert

public StatusRaisedAlert(Alert alert,
                         String cause,
                         StateBundle state,
                         RaisedAlertSummary raisedAlertSummary)

Build a StatusAlert from the provided RaisedAlert.

Parameters:

alert - The RaisedAlert object that caused the publication of this StatusAlert.

cause - What caused the Alert to be raised.

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

raisedAlertSummary - the summary of all uncleared alerts at the time the object is created.

Method Detail

getRaisedAlert

public Alert getRaisedAlert()

Get the RaisedAlert contained in this message.

Returns:

The RaisedAlert.

encodeObject

protected Alert encodeObject(Alert obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<Alert,Alert>

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.

getCause

public String getCause()

Get the String explaining what caused the Alert.

Returns:

the cause of the Alert.