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.

Author:

tether

Constructor Summary

Constructors

Constructor and Description
Alerts()

Method Summary

Modifier and Type	Method and Description
static org.lsst.ccs.bus.data.Alert	emailDeliveryAlert() Creates an alert about a failure to build or deliver an email message.
static org.lsst.ccs.bus.data.Alert	instrumentIOAlert(String location) Creates an alert about a failure to read an instrument.
static org.lsst.ccs.bus.data.Alert	instrumentMalfunctionAlert(String location, String channelName) Creates an alert about a sensor malfunction reported by the instrument.
static org.lsst.ccs.bus.data.Alert	limitViolationAlert(String shortLocationName, String channelName) Creates an alert about an a sensor reading that's outside of the desired range.

Methods inherited from class java.lang.Object

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

Constructor Detail

Alerts

public Alerts()

Method Detail

emailDeliveryAlert

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

Creates an alert about a failure to build or deliver an email message.

Returns:

A new Alert instance with an ID of "EmailDelivery".

instrumentIOAlert

public static org.lsst.ccs.bus.data.Alert instrumentIOAlert(String location)

Creates an alert about a failure to read an instrument.

Parameters:

location - The long location name of the instrument, e.g., "Location 002".

Returns:

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

instrumentMalfunctionAlert

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

Creates an alert about a sensor malfunction reported by the instrument.

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("Malfunction-%s-%s", location, channelName).

limitViolationAlert

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

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

Parameters:

shortLocationName - 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", shortLocationName, channelName).