org.lsst.ccs.subsystem.airwatch.main

Enum Alerts

java.lang.Object

java.lang.Enum<Alerts>

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

All Implemented Interfaces:

Serializable, Comparable<Alerts>

public enum Alerts
extends Enum<Alerts>

All the alerts that this subsystem can raise.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATA_QUALITY Raised if something went wrong when the sensor tried to make a new measurement.
LIMIT_VIOLATION Raised if the Lighthouse application has flagged a sensor reading as out of bounds.
SENSOR_IO Raised if we can't read sensor data from the Lighthouse PC.

Method Summary

Modifier and Type	Method and Description
static String	analogViolationMsg(String locName, String chanName, double value, double lowerLimit, double upperLimit) Constructs a cause message of the form
static String	counterViolationMsg(String locName, String chanName, double value) Constructs a cause message of the form
static String	dataQualityMsg(String locName, String chanName, String quality) Constructs a cause message of the form
void	raise(org.lsst.ccs.services.alert.AlertService alertSvc, org.lsst.ccs.bus.states.AlertState severity, String cause, org.lsst.ccs.services.alert.AlertService.RaiseAlertStrategy strategy) Raises the alert associated with this enumeration member.
static void	registerAll(org.lsst.ccs.services.alert.AlertService alertSvc) Register all alert objects, associating the clear-alert handler ClearAlertHandler.ALWAYS with each.
static Alerts	valueOf(String name) Returns the enum constant of this type with the specified name.
static Alerts[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SENSOR_IO

public static final Alerts SENSOR_IO

Raised if we can't read sensor data from the Lighthouse PC.

LIMIT_VIOLATION

public static final Alerts LIMIT_VIOLATION

Raised if the Lighthouse application has flagged a sensor reading as out of bounds.

DATA_QUALITY

public static final Alerts DATA_QUALITY

Raised if something went wrong when the sensor tried to make a new measurement.

Method Detail

values

public static Alerts[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Alerts c : Alerts.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Alerts valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

raise

public void raise(org.lsst.ccs.services.alert.AlertService alertSvc,
                  org.lsst.ccs.bus.states.AlertState severity,
                  String cause,
                  org.lsst.ccs.services.alert.AlertService.RaiseAlertStrategy strategy)

Raises the alert associated with this enumeration member.

Parameters:

alertSvc - the CCS alert service.

severity - the state which the raised alert is to have.

cause - the cause string which the raised alert is to have.

strategy - the alert-raising strategy.

registerAll

public static void registerAll(org.lsst.ccs.services.alert.AlertService alertSvc)

Register all alert objects, associating the clear-alert handler ClearAlertHandler.ALWAYS with each.

Parameters:

alertSvc -

dataQualityMsg

public static String dataQualityMsg(String locName,
                                    String chanName,
                                    String quality)

Constructs a cause message of the form

LOCATION CHANNEL QUALITY|Data quality is QUALITY for CHANNEL at LOCATION.

Parameters:

locName - the location of the sensor, for example MAIN_NW.

chanName - the sensor channel, for example TEMP.

quality - the data quality estimate, for example Questionable.

analogViolationMsg

public static String analogViolationMsg(String locName,
                                        String chanName,
                                        double value,
                                        double lowerLimit,
                                        double upperLimit)

Constructs a cause message of the form

LOCATION CHANNEL VALUE LOWER UPPER|Limit violation for CHANNEL at LOCATION. Value is VALUE, allowed range is [LOWER, UPPER].

Parameters:

locName - the location of the sensor, for example MAIN_NW.

chanName - the sensor channel, for example TEMP.

value - the sensor reading.

lowerLimit - the lower limit.

upperLimit - the upper limit.

Returns:

the formatted message.

counterViolationMsg

public static String counterViolationMsg(String locName,
                                         String chanName,
                                         double value)

Constructs a cause message of the form

LOCATION CHANNEL VALUE |Density of VALUE for particle size CHANNEL at LOCATION is too high.

Parameters:

locName - the location of the sensor, for example MAIN_NW.

chanName - the sensor channel, for example TEMP.

value - the sensor reading.

Returns:

the formatted message.