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. 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. The class is thread-safe as long as its instances are safely published.

Author:

The LSST CCS Team.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addAlertInstance(AlertState severity, Alert alert) Add a new instance of this Alert.
void	addAlertInstance(AlertState severity, Alert alert, long timestamp, String cause) Add a new instance of this Alert.
AlertState	getHighestAlertState() Get the highest AlertState raised for this Alert.
Alert	getLatestAlert() Get the original Alert that was raised.
AlertState	getLatestAlertState() Get the latest AlertState of this Alert.
long	getLatestAlertTimestamp() Get the latest CCS timestamp of this Alert.
int	getNumberOfInstances() Get the number of times this Alert was raised.
List<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.

RaisedAlertHistory

public RaisedAlertHistory(RaisedAlertHistory other)

Copy constructor.

Parameters:

other - Instance to be cloned.

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,
                             long timestamp,
                             String cause)

Add a new instance of this Alert.

Parameters:

severity - The AlertState of the Alert.

alert - The Alert that was raised.

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

cause - The cause of the Alert.

addAlertInstance

protected void addAlertInstance(AlertState severity,
                                Alert alert)

Add a new instance of this Alert. The current CCS timestamp is used.

Parameters:

severity - The AlertState of the Alert.

alert - The Alert that was raised.

getNumberOfInstances

public int getNumberOfInstances()

Get the number of times this Alert was raised.

Returns:

the number of times the 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.

getLatestAlertTimestamp

public long getLatestAlertTimestamp()

Get the latest CCS timestamp of this Alert.

Returns:

Get the CCS timestamp of 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.

getRaisedAlertInstancesList

public List<RaisedAlertInstance> getRaisedAlertInstancesList()

Get the full history of RaisedAlertInstances for this Alert.

Returns:

The List containing the RaisedAlertInstances for this Alert.

toString

public String toString()

Overrides:

toString in class Object