org.lsst.ccs.subsystem.airwatch.main

Class Alerts

java.lang.Object

org.lsst.ccs.subsystem.airwatch.main.Alerts

public class Alerts
extends Object

Contains a set of static factory functions for the alerts used by the subsystem. Can't be instantiated.

Author:

tether

Method Summary

Modifier and Type	Method and Description
static org.lsst.ccs.bus.data.Alert	dataQualityAlert(String location, String channelName) Creates an alert about a sensor malfunction or questionable data quality.
static org.lsst.ccs.bus.data.Alert	limitViolationAlert(String location, String channelName) Creates an alert about an a sensor reading that's outside of the desired range.
static org.lsst.ccs.bus.data.Alert	sensorIOAlert() Creates an alert about a failure to read sensor data.

Methods inherited from class java.lang.Object

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

Method Detail

sensorIOAlert

public static org.lsst.ccs.bus.data.Alert sensorIOAlert()

Creates an alert about a failure to read sensor data.

Returns:

A new Alert instance with an ID of SensorIO.

limitViolationAlert

public static org.lsst.ccs.bus.data.Alert limitViolationAlert(String location,
                                                              String channelName)

Creates an alert about an a sensor reading that's outside of the desired range.

Parameters:

location - The location of the instrument, e.g., ENTRY, MAIN_SE.

channelName - Which quantity has gone out of range, e.g., 0.3, Humidity.

Returns:

A new Alert instance with an ID of format("LimitViolation-%s-%s", location, channelName).

dataQualityAlert

public static org.lsst.ccs.bus.data.Alert dataQualityAlert(String location,
                                                           String channelName)

Creates an alert about a sensor malfunction or questionable data quality.

Parameters:

location - The short location name of the instrument, e.g., AUX, MAIN_SE.

channelName - The name of the channel that had the failure.

Returns:

A new Alert instance with an ID of format("DataQuality-%s-%s", location, channelName).