org.lsst.ccs.bus.data

Class RaisedAlertSummary

java.lang.Object

org.lsst.ccs.bus.data.RaisedAlertSummary

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RaisedAlertBookkeeper

public class RaisedAlertSummary
extends Object
implements Serializable

A summary of the alerts that have been raised by a Subsystem. This class is used internally by a Subsystem to internally keep a record of the Alerts that have been raised. It is also published on the buses to provide a summary of the subsystem's raised alerts. This class is thread safe.

Author:

The LSST CCS Team.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<RaisedAlertHistory>	raisedAlerts

Constructor Summary

Constructors

Constructor and Description
RaisedAlertSummary()

Method Summary

Modifier and Type	Method and Description
AlertState	getAlertState() Get the overall AlertState for this RaisedAlarm summary object .
Set<RaisedAlertHistory>	getAllRaisedAlertHistories() Get the set of raised Alerts.
RaisedAlertHistory	getRaisedAlert(String alertId) Get a RaisedAlert for a given id.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

raisedAlerts

protected final List<RaisedAlertHistory> raisedAlerts

Constructor Detail

RaisedAlertSummary

public RaisedAlertSummary()

Method Detail

getRaisedAlert

public RaisedAlertHistory getRaisedAlert(String alertId)

Get a RaisedAlert for a given id.

Parameters:

alertId - The alert Id

Returns:

The corresponding RaisedAlert.

getAlertState

public AlertState getAlertState()

Get the overall AlertState for this RaisedAlarm summary object . This is the highest AlertState among all the RaisedAlerts for the subsystem.

Returns:

The highest AlertState.

getAllRaisedAlertHistories

public Set<RaisedAlertHistory> getAllRaisedAlertHistories()

Get the set of raised Alerts.

Returns:

The Set of RaisedAlertHistories.

toString

public String toString()

Overrides:

toString in class Object