org.yamcs.alarms

Class AlarmReporter

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.alarms.AlarmReporter

All Implemented Interfaces:

com.google.common.util.concurrent.Service, ParameterConsumer

public class AlarmReporter
extends com.google.common.util.concurrent.AbstractService
implements ParameterConsumer

Generates realtime alarm events automatically, by subscribing to all relevant parameters.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Constructor Summary

Constructors

Constructor and Description
AlarmReporter(String yamcsInstance)
AlarmReporter(String yamcsInstance, String yprocName)

Method Summary

Modifier and Type	Method and Description
void	doStart()
void	doStop()
void	reportEnumeratedParameterEvent(ParameterValue pv, AlarmType alarmType, int minViolations)
void	reportNumericParameterEvent(ParameterValue pv, AlarmType alarmType, int minViolations) Sends an event if an alarm condition for the active context has been triggered minViolations times.
void	updateItems(int subscriptionId, List<ParameterValue> items)

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmReporter

public AlarmReporter(String yamcsInstance)

AlarmReporter

public AlarmReporter(String yamcsInstance,
                     String yprocName)

Method Detail

doStart

public void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

doStop

public void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService

updateItems

public void updateItems(int subscriptionId,
                        List<ParameterValue> items)

Specified by:

updateItems in interface ParameterConsumer

reportNumericParameterEvent

public void reportNumericParameterEvent(ParameterValue pv,
                                        AlarmType alarmType,
                                        int minViolations)

Sends an event if an alarm condition for the active context has been triggered minViolations times. This configuration does not affect events for parameters that go back to normal, or that change severity levels while the alarm is already active.

reportEnumeratedParameterEvent

public void reportEnumeratedParameterEvent(ParameterValue pv,
                                           AlarmType alarmType,
                                           int minViolations)