org.lsst.ccs.bus.data

Class RaisedAlertHistory

java.lang.Object

org.lsst.ccs.bus.data.RaisedAlertHistory

All Implemented Interfaces:

Serializable

public final class RaisedAlertHistory
extends Object
implements Serializable

A history of alerts for a specific alert ID, since the last clear. An instance of this class contains a list of RaisedAlertInstance objects created by calls to addAlertInstance(...) method. This class is meant to be sent over the buses as part of a RaisedAlertSummary object.

Author:

The LSST CCS Team.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RaisedAlertHistory() The main constructor of the RaisedAlert.

Method Summary

Modifier and Type	Method and Description
void	addAlertInstance(AlertState severity, Alert alert, org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp, String cause, int count) Add a new instance of this Alert.
int	getAccumulatedNumberOfInstances() Get the accumulated number of times this alert was raised.
Alert	getHighestAlert() Get the highest state Alert raised for this Alert, i.e.
AlertState	getHighestAlertState() Get the highest AlertState raised for this Alert.
Alert	getLatestAlert() Get the original Alert that was raised.
String	getLatestAlertCause() Gets the latest cause of this Alert.
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getLatestAlertCCSTimeStamp() Get the latest CCS timestamp of this Alert.
RaisedAlertInstance	getLatestAlertInstance() Gets the latest raised instance of this alert.
AlertState	getLatestAlertState() Get the latest AlertState of this Alert.
int	getNumberOfInstances() Get the number of times this Alert was raised.
ArrayList<RaisedAlertInstance>	getRaisedAlertInstancesList() Get the full history of RaisedAlertInstances for this Alert.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RaisedAlertHistory

public RaisedAlertHistory()

The main constructor of the RaisedAlert.

Method Detail

getLatestAlert

public Alert getLatestAlert()

Get the original Alert that was raised.

Returns:

The original Alert that was raised.

addAlertInstance

public void addAlertInstance(AlertState severity,
                             Alert alert,
                             org.lsst.ccs.utilities.taitime.CCSTimeStamp ccsTimeStamp,
                             String cause,
                             int count)

Add a new instance of this Alert.

Parameters:

severity - The AlertState of the Alert.

alert - The Alert that was raised.

ccsTimeStamp - The CCS timestamp of when the Alert was raised.

cause - The cause of the Alert.

count - the number of alerts this instance stands for.

getNumberOfInstances

public int getNumberOfInstances()

Get the number of times this Alert was raised.

Returns:

the number of times the Alert was raised.

getAccumulatedNumberOfInstances

public int getAccumulatedNumberOfInstances()

Get the accumulated number of times this alert was raised.

Returns:

the accumulated number of times this alert was raised.

getLatestAlertState

public AlertState getLatestAlertState()

Get the latest AlertState of this Alert.

Returns:

Get the AlertState of the last time this Alert was raised.

getLatestAlertCCSTimeStamp

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

Get the latest CCS timestamp of this Alert.

Returns:

Get the CCS timestamp of the last time this Alert was raised.

getLatestAlertCause

public String getLatestAlertCause()

Gets the latest cause of this Alert.

Returns:

the cause that was associated to the latest instance of this alert.

getLatestAlertInstance

public RaisedAlertInstance getLatestAlertInstance()

Gets the latest raised instance of this alert.

Returns:

a RaisedAlertInstance depicting the last time this alert was raised.

getHighestAlertState

public AlertState getHighestAlertState()

Get the highest AlertState raised for this Alert.

Returns:

The highest AlertState for this Alert.

getHighestAlert

public Alert getHighestAlert()

Get the highest state Alert raised for this Alert, i.e. the Alert that was raised with the highest severity.

Returns:

The highest Alert for this Alert.

getRaisedAlertInstancesList

public ArrayList<RaisedAlertInstance> getRaisedAlertInstancesList()

Get the full history of RaisedAlertInstances for this Alert.

Returns:

List of RaisedAlertInstances for this history, in increasing time order.

toString

public String toString()

Overrides:

toString in class Object