org.lsst.ccs.messaging.util

Class AlertGate

java.lang.Object

org.lsst.ccs.messaging.util.AlertGate

public class AlertGate
extends Object

Raises an alert or logs a message when the input crosses thresholds, taking care not to do so too often for the same reason. This class is thread-safe.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
AlertGate(Dispatcher dispatcher, String alertID, String alertDescription, int[] thresholds) Creates an instance with vetoTime = 5000 and vetoFactor = 1.5.
AlertGate(Dispatcher dispatcher, String alertID, String alertDescription, int[] thresholds, int vetoTime, double vetoFactor) Constructs an instance, registering new Alert with the Dispatcher.

Method Summary

Modifier and Type	Method and Description
void	check(int value) Checks the value and takes appropriate action.
protected String	getMessage(int value)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertGate

public AlertGate(Dispatcher dispatcher,
                 String alertID,
                 String alertDescription,
                 int[] thresholds,
                 int vetoTime,
                 double vetoFactor)

Constructs an instance, registering new Alert with the Dispatcher.

Parameters:

dispatcher - Dispatcher through which alerts should be raised and messages logged.

alertID - ID for Alert raised through this gate.

alertDescription - Description of the Alert.

thresholds - Array of thresholds. Contains no more than 3 elements: log, warning, alarm.

vetoTime - Veto time in milliseconds.

vetoFactor - Veto factor.

AlertGate

public AlertGate(Dispatcher dispatcher,
                 String alertID,
                 String alertDescription,
                 int[] thresholds)

Creates an instance with vetoTime = 5000 and vetoFactor = 1.5. The new Alert is registered with the Dispatcher.

Parameters:

dispatcher - Dispatcher through which alerts should be raised and messages logged.

alertID - ID for Alert raised through this gate.

alertDescription - Description of the Alert.

thresholds - Array of thresholds.

Method Detail

check

public void check(int value)

Checks the value and takes appropriate action.

Parameters:

value - Current value of the watched quantity.

getMessage

protected String getMessage(int value)