org.yamcs.protobuf.alarms.GlobalAlarmStatusOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/alarms/alarms_service.proto

package org.yamcs.protobuf.alarms;

public interface GlobalAlarmStatusOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.alarms.GlobalAlarmStatus)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The number of active unacknowledged alarms
   * 
   *
   * optional int32 unacknowledgedCount = 1;
   * @return Whether the unacknowledgedCount field is set.
   */
  boolean hasUnacknowledgedCount();
  /**
   *    * The number of active unacknowledged alarms
   * 
   *
   * optional int32 unacknowledgedCount = 1;
   * @return The unacknowledgedCount.
   */
  int getUnacknowledgedCount();

  /**
   *    * True if there is at least one unacknowledged alarm not OK
   * (i.e. latest value of parameter still out of limits)
   * 
   *
   * optional bool unacknowledgedActive = 2;
   * @return Whether the unacknowledgedActive field is set.
   */
  boolean hasUnacknowledgedActive();
  /**
   *    * True if there is at least one unacknowledged alarm not OK
   * (i.e. latest value of parameter still out of limits)
   * 
   *
   * optional bool unacknowledgedActive = 2;
   * @return The unacknowledgedActive.
   */
  boolean getUnacknowledgedActive();

  /**
   *    * Highest severity among all unacknowledged alarms
   * 
   *
   * optional .yamcs.protobuf.alarms.AlarmSeverity unacknowledgedSeverity = 7;
   * @return Whether the unacknowledgedSeverity field is set.
   */
  boolean hasUnacknowledgedSeverity();
  /**
   *    * Highest severity among all unacknowledged alarms
   * 
   *
   * optional .yamcs.protobuf.alarms.AlarmSeverity unacknowledgedSeverity = 7;
   * @return The unacknowledgedSeverity.
   */
  org.yamcs.protobuf.AlarmSeverity getUnacknowledgedSeverity();

  /**
   *    * The number of active acknowledged alarms
   * 
   *
   * optional int32 acknowledgedCount = 3;
   * @return Whether the acknowledgedCount field is set.
   */
  boolean hasAcknowledgedCount();
  /**
   *    * The number of active acknowledged alarms
   * 
   *
   * optional int32 acknowledgedCount = 3;
   * @return The acknowledgedCount.
   */
  int getAcknowledgedCount();

  /**
   *    * True if there is at least one acknowledged alarm not OK
   * (i.e. latest value of parameter still out of limits)
   * 
   *
   * optional bool acknowledgedActive = 4;
   * @return Whether the acknowledgedActive field is set.
   */
  boolean hasAcknowledgedActive();
  /**
   *    * True if there is at least one acknowledged alarm not OK
   * (i.e. latest value of parameter still out of limits)
   * 
   *
   * optional bool acknowledgedActive = 4;
   * @return The acknowledgedActive.
   */
  boolean getAcknowledgedActive();

  /**
   *    * Highest severity among all acknowledged alarms
   * 
   *
   * optional .yamcs.protobuf.alarms.AlarmSeverity acknowledgedSeverity = 8;
   * @return Whether the acknowledgedSeverity field is set.
   */
  boolean hasAcknowledgedSeverity();
  /**
   *    * Highest severity among all acknowledged alarms
   * 
   *
   * optional .yamcs.protobuf.alarms.AlarmSeverity acknowledgedSeverity = 8;
   * @return The acknowledgedSeverity.
   */
  org.yamcs.protobuf.AlarmSeverity getAcknowledgedSeverity();

  /**
   *    * The number of shelved alarms
   * 
   *
   * optional int32 shelvedCount = 5;
   * @return Whether the shelvedCount field is set.
   */
  boolean hasShelvedCount();
  /**
   *    * The number of shelved alarms
   * 
   *
   * optional int32 shelvedCount = 5;
   * @return The shelvedCount.
   */
  int getShelvedCount();

  /**
   *    * True if there is at least one shelved alarm not OK (i.e. latest value of parameter still out of limits)
   * 
   *
   * optional bool shelvedActive = 6;
   * @return Whether the shelvedActive field is set.
   */
  boolean hasShelvedActive();
  /**
   *    * True if there is at least one shelved alarm not OK (i.e. latest value of parameter still out of limits)
   * 
   *
   * optional bool shelvedActive = 6;
   * @return The shelvedActive.
   */
  boolean getShelvedActive();

  /**
   *    * Highest severity among all shelved alarms
   * 
   *
   * optional .yamcs.protobuf.alarms.AlarmSeverity shelvedSeverity = 9;
   * @return Whether the shelvedSeverity field is set.
   */
  boolean hasShelvedSeverity();
  /**
   *    * Highest severity among all shelved alarms
   * 
   *
   * optional .yamcs.protobuf.alarms.AlarmSeverity shelvedSeverity = 9;
   * @return The shelvedSeverity.
   */
  org.yamcs.protobuf.AlarmSeverity getShelvedSeverity();
}