org.lsst.ccs.bus.data

Class RaisedAlertInstance

java.lang.Object

org.lsst.ccs.bus.data.RaisedAlertInstance

All Implemented Interfaces:

Serializable

public final class RaisedAlertInstance
extends Object
implements Serializable

This class represents an instance when an Alert was raised. It contains the CCS timestamp of when the Alert was raised and the AlertState with which it was raised. This object can stand for several raised alert events if those alerts are raised at a high rate, in which case the CCS timestamp corresponds to the first time the alert was raised, and the cause to the latest alert cause. This class is immutable outside of the package it belongs to.

Author:

The LSST CCS Team

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
AlertState	getAlertState() The AlertState at which the RaisedAlertInstance was raised.
String	getCause() What caused this alert to be raised.
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getCCSTimeStamp() The CCS timestamp of when the RaisedAlertInstance was raised.
int	getCount() The number of time this alert was raised.

Methods inherited from class java.lang.Object

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

Method Detail

getCCSTimeStamp

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

The CCS timestamp of when the RaisedAlertInstance was raised.

Returns:

The CCSTimeStamp.

getAlertState

public AlertState getAlertState()

The AlertState at which the RaisedAlertInstance was raised.

Returns:

The AlertState of the Alert.

getCause

public String getCause()

What caused this alert to be raised.

Returns:

The description of this instance of the RaisedAlert.

getCount

public int getCount()

The number of time this alert was raised.

Returns: