Package org.yamcs.alarms

Class AlarmReporter

java.lang.Object
com.google.common.util.concurrent.AbstractService
org.yamcs.AbstractProcessorService
org.yamcs.alarms.AlarmReporter
All Implemented Interfaces:
com.google.common.util.concurrent.Service, ProcessorService
public class AlarmReporter extends AbstractProcessorService implements ProcessorService
Generates events for parameters out of limits.

This was used when Yamcs did not have the AlarmServer. It may be removed in the future.

  • 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

  • Field Summary

    Fields inherited from class org.yamcs.AbstractProcessorService

    config, log, processor

  • Constructor Summary

    Constructors
    Constructor
    Description
    AlarmReporter()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doStart()
     
    void
    doStop()
     
    void
    init(Processor processor, YConfiguration config, Object spec)
     
    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.

    Methods inherited from class org.yamcs.AbstractProcessorService

    getConfig, getYamcsInstance

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

    addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, 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

    Methods inherited from interface org.yamcs.ProcessorService

    getSpec

    Methods inherited from interface com.google.common.util.concurrent.Service

    addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

  • Constructor Details

    • AlarmReporter

      public AlarmReporter()

  • Method Details

    • init

      public void init(Processor processor, YConfiguration config, Object spec)
      Specified by:
      init in interface ProcessorService
      Overrides:
      init in class AbstractProcessorService
      config - service configuration as specified in processor.yaml
      spec - passed by the user when creating the processor (for instance via the REST API)

    • 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

    • 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)