org.lsst.ccs.bus.messages

Class StatusClearedAlert

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<String[],Object>

org.lsst.ccs.bus.messages.StatusClearedAlert

All Implemented Interfaces:

Serializable

public final class StatusClearedAlert
extends StatusAlert<String[],Object>

Status message sent when Alerts are cleared. It contains a String array of the alertIds that have been cleared

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusClearedAlert(String[] clearAlertIds, StateBundle state, RaisedAlertSummary raisedAlertSummary) Build a StatusClearAlert from the provided String array and the RaisedAlertSummary of the subsystem.

Method Summary

Modifier and Type	Method and Description
protected Object	encodeObject(String[] obj) Subclasses must provide a specific implementation of the encoding process.
String[]	getClearAlertIds() Get the String array of the alertIds that have been cleared.

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

StatusClearedAlert

public StatusClearedAlert(String[] clearAlertIds,
                          StateBundle state,
                          RaisedAlertSummary raisedAlertSummary)

Build a StatusClearAlert from the provided String array and the RaisedAlertSummary of the subsystem.

Parameters:

clearAlertIds - Array of AlertIds that have been cleared.

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

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

Method Detail

getClearAlertIds

public String[] getClearAlertIds()

Get the String array of the alertIds that have been cleared.

Returns:

The String array of with the ids of the alerts that have been cleared.

encodeObject

protected Object encodeObject(String[] obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<String[],Object>

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.