Package org.yamcs.protobuf

Interface AlarmDataOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AlarmData, AlarmData.Builder
    public interface AlarmDataOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getAcknowledged()
      if the operator has acknowledged the alarm
      AcknowledgeInfo getAcknowledgeInfo()
      optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
      AcknowledgeInfoOrBuilder getAcknowledgeInfoOrBuilder()
      optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
      ClearInfo getClearInfo()
      optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
      ClearInfoOrBuilder getClearInfoOrBuilder()
      optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
      int getCount()
      Number of samples received for the object
      EventAlarmData getEventDetail()
      optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
      EventAlarmDataOrBuilder getEventDetailOrBuilder()
      optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
      Yamcs.NamedObjectId getId()
      For parameter alarms, this is the id of the parameters For event alarms - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless EVENT_SOURCE starts with a "/" in which case the namespace is just the <EVENT_SOURCE> - the id.name is the <EVENT_TYPE>
      Yamcs.NamedObjectIdOrBuilder getIdOrBuilder()
      For parameter alarms, this is the id of the parameters For event alarms - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless EVENT_SOURCE starts with a "/" in which case the namespace is just the <EVENT_SOURCE> - the id.name is the <EVENT_TYPE>
      boolean getLatching()
      Whether the alarm will stay triggered even when the process is OK
      AlarmNotificationType getNotificationType()
      optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
      ParameterAlarmData getParameterDetail()
      optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
      ParameterAlarmDataOrBuilder getParameterDetailOrBuilder()
      optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
      boolean getProcessOK()
      if the process that generated the alarm is ok (i.e. parameter is within limits)
      int getSeqNum()
      Distinguisher between multiple alarms for the same id
      AlarmSeverity getSeverity()
      optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
      ShelveInfo getShelveInfo()
      Details in case the alarm was shelved
      ShelveInfoOrBuilder getShelveInfoOrBuilder()
      Details in case the alarm was shelved
      boolean getTriggered()
      triggered is same with processOK except when the alarm is latching
      com.google.protobuf.Timestamp getTriggerTime()
      optional .google.protobuf.Timestamp triggerTime = 2;
      com.google.protobuf.TimestampOrBuilder getTriggerTimeOrBuilder()
      optional .google.protobuf.Timestamp triggerTime = 2;
      AlarmType getType()
      optional .yamcs.protobuf.alarms.AlarmType type = 1;
      int getViolations()
      Number of times the object was in alarm state
      boolean hasAcknowledged()
      if the operator has acknowledged the alarm
      boolean hasAcknowledgeInfo()
      optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
      boolean hasClearInfo()
      optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
      boolean hasCount()
      Number of samples received for the object
      boolean hasEventDetail()
      optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
      boolean hasId()
      For parameter alarms, this is the id of the parameters For event alarms - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless EVENT_SOURCE starts with a "/" in which case the namespace is just the <EVENT_SOURCE> - the id.name is the <EVENT_TYPE>
      boolean hasLatching()
      Whether the alarm will stay triggered even when the process is OK
      boolean hasNotificationType()
      optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
      boolean hasParameterDetail()
      optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
      boolean hasProcessOK()
      if the process that generated the alarm is ok (i.e. parameter is within limits)
      boolean hasSeqNum()
      Distinguisher between multiple alarms for the same id
      boolean hasSeverity()
      optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
      boolean hasShelveInfo()
      Details in case the alarm was shelved
      boolean hasTriggered()
      triggered is same with processOK except when the alarm is latching
      boolean hasTriggerTime()
      optional .google.protobuf.Timestamp triggerTime = 2;
      boolean hasType()
      optional .yamcs.protobuf.alarms.AlarmType type = 1;
      boolean hasViolations()
      Number of times the object was in alarm state

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasType

        boolean hasType()
        optional .yamcs.protobuf.alarms.AlarmType type = 1;

      • getType

        AlarmType getType()
        optional .yamcs.protobuf.alarms.AlarmType type = 1;

      • hasTriggerTime

        boolean hasTriggerTime()
        optional .google.protobuf.Timestamp triggerTime = 2;

      • getTriggerTime

        com.google.protobuf.Timestamp getTriggerTime()
        optional .google.protobuf.Timestamp triggerTime = 2;

      • getTriggerTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getTriggerTimeOrBuilder()
        optional .google.protobuf.Timestamp triggerTime = 2;

      • hasId

        boolean hasId()
         For parameter alarms, this is the id of the parameters
 For event alarms
   - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless 
     EVENT_SOURCE starts with a "/" in which case the namespace
     is just the <EVENT_SOURCE>
   - the id.name is the <EVENT_TYPE>
        optional .yamcs.protobuf.NamedObjectId id = 3;

      • getId

        Yamcs.NamedObjectId getId()
         For parameter alarms, this is the id of the parameters
 For event alarms
   - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless 
     EVENT_SOURCE starts with a "/" in which case the namespace
     is just the <EVENT_SOURCE>
   - the id.name is the <EVENT_TYPE>
        optional .yamcs.protobuf.NamedObjectId id = 3;

      • getIdOrBuilder

        Yamcs.NamedObjectIdOrBuilder getIdOrBuilder()
         For parameter alarms, this is the id of the parameters
 For event alarms
   - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless 
     EVENT_SOURCE starts with a "/" in which case the namespace
     is just the <EVENT_SOURCE>
   - the id.name is the <EVENT_TYPE>
        optional .yamcs.protobuf.NamedObjectId id = 3;

      • hasSeqNum

        boolean hasSeqNum()
         Distinguisher between multiple alarms for the same id
        optional uint32 seqNum = 4;

      • getSeqNum

        int getSeqNum()
         Distinguisher between multiple alarms for the same id
        optional uint32 seqNum = 4;

      • hasSeverity

        boolean hasSeverity()
        optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;

      • getSeverity

        AlarmSeverity getSeverity()
        optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;

      • hasViolations

        boolean hasViolations()
         Number of times the object was in alarm state
        optional uint32 violations = 6;

      • getViolations

        int getViolations()
         Number of times the object was in alarm state
        optional uint32 violations = 6;

      • hasCount

        boolean hasCount()
         Number of samples received for the object
        optional uint32 count = 7;

      • getCount

        int getCount()
         Number of samples received for the object
        optional uint32 count = 7;

      • hasAcknowledgeInfo

        boolean hasAcknowledgeInfo()
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

      • getAcknowledgeInfo

        AcknowledgeInfo getAcknowledgeInfo()
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

      • getAcknowledgeInfoOrBuilder

        AcknowledgeInfoOrBuilder getAcknowledgeInfoOrBuilder()
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

      • hasNotificationType

        boolean hasNotificationType()
        optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;

      • getNotificationType

        AlarmNotificationType getNotificationType()
        optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;

      • hasParameterDetail

        boolean hasParameterDetail()
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

      • getParameterDetail

        ParameterAlarmData getParameterDetail()
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

      • getParameterDetailOrBuilder

        ParameterAlarmDataOrBuilder getParameterDetailOrBuilder()
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

      • hasEventDetail

        boolean hasEventDetail()
        optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;

      • getEventDetail

        EventAlarmData getEventDetail()
        optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;

      • getEventDetailOrBuilder

        EventAlarmDataOrBuilder getEventDetailOrBuilder()
        optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;

      • hasLatching

        boolean hasLatching()
         Whether the alarm will stay triggered even when the process is OK
        optional bool latching = 12;

      • getLatching

        boolean getLatching()
         Whether the alarm will stay triggered even when the process is OK
        optional bool latching = 12;

      • hasProcessOK

        boolean hasProcessOK()
         if the process that generated the alarm is ok (i.e. parameter is within limits)
        optional bool processOK = 13;

      • getProcessOK

        boolean getProcessOK()
         if the process that generated the alarm is ok (i.e. parameter is within limits)
        optional bool processOK = 13;

      • hasTriggered

        boolean hasTriggered()
         triggered is same with processOK except when the alarm is latching
        optional bool triggered = 14;

      • getTriggered

        boolean getTriggered()
         triggered is same with processOK except when the alarm is latching
        optional bool triggered = 14;

      • hasAcknowledged

        boolean hasAcknowledged()
         if the operator has acknowledged the alarm
        optional bool acknowledged = 15;

      • getAcknowledged

        boolean getAcknowledged()
         if the operator has acknowledged the alarm
        optional bool acknowledged = 15;

      • hasShelveInfo

        boolean hasShelveInfo()
         Details in case the alarm was shelved
        optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

      • getShelveInfo

        ShelveInfo getShelveInfo()
         Details in case the alarm was shelved
        optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

      • getShelveInfoOrBuilder

        ShelveInfoOrBuilder getShelveInfoOrBuilder()
         Details in case the alarm was shelved
        optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

      • hasClearInfo

        boolean hasClearInfo()
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;

      • getClearInfo

        ClearInfo getClearInfo()
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;

      • getClearInfoOrBuilder

        ClearInfoOrBuilder getClearInfoOrBuilder()
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;