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()
      Additional detail in case the alarm is of type EVENT
      EventAlarmDataOrBuilder getEventDetailOrBuilder()
      Additional detail in case the alarm is of type EVENT
      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()
      Additional detail in case the alarm is of type PARAMETER
      ParameterAlarmDataOrBuilder getParameterDetailOrBuilder()
      Additional detail in case the alarm is of type PARAMETER
      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;
      com.google.protobuf.Timestamp getUpdateTime()
      Time when the alarm was last updated
      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
      Time when the alarm was last updated
      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()
      Additional detail in case the alarm is of type EVENT
      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()
      Additional detail in case the alarm is of type PARAMETER
      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 hasUpdateTime()
      Time when the alarm was last updated
      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;
        Returns:
        Whether the type field is set.

      • getType

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

      • hasTriggerTime

        boolean hasTriggerTime()
        optional .google.protobuf.Timestamp triggerTime = 2;
        Returns:
        Whether the triggerTime field is set.

      • getTriggerTime

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

      • 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;
        Returns:
        Whether the id field is set.

      • 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;
        Returns:
        The id.

      • 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;
        Returns:
        Whether the seqNum field is set.

      • getSeqNum

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

      • hasSeverity

        boolean hasSeverity()
        optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
        Returns:
        Whether the severity field is set.

      • getSeverity

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

      • hasViolations

        boolean hasViolations()
         Number of times the object was in alarm state
        optional uint32 violations = 6;
        Returns:
        Whether the violations field is set.

      • getViolations

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

      • hasCount

        boolean hasCount()
         Number of samples received for the object
        optional uint32 count = 7;
        Returns:
        Whether the count field is set.

      • getCount

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

      • hasAcknowledgeInfo

        boolean hasAcknowledgeInfo()
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
        Returns:
        Whether the acknowledgeInfo field is set.

      • getAcknowledgeInfo

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

      • getAcknowledgeInfoOrBuilder

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

      • hasNotificationType

        boolean hasNotificationType()
        optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
        Returns:
        Whether the notificationType field is set.

      • getNotificationType

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

      • hasParameterDetail

        boolean hasParameterDetail()
         Additional detail in case the alarm is of type PARAMETER
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
        Returns:
        Whether the parameterDetail field is set.

      • getParameterDetail

        ParameterAlarmData getParameterDetail()
         Additional detail in case the alarm is of type PARAMETER
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
        Returns:
        The parameterDetail.

      • getParameterDetailOrBuilder

        ParameterAlarmDataOrBuilder getParameterDetailOrBuilder()
         Additional detail in case the alarm is of type PARAMETER
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

      • hasEventDetail

        boolean hasEventDetail()
         Additional detail in case the alarm is of type EVENT
        optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
        Returns:
        Whether the eventDetail field is set.

      • getEventDetail

        EventAlarmData getEventDetail()
         Additional detail in case the alarm is of type EVENT
        optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
        Returns:
        The eventDetail.

      • getEventDetailOrBuilder

        EventAlarmDataOrBuilder getEventDetailOrBuilder()
         Additional detail in case the alarm is of type EVENT
        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;
        Returns:
        Whether the latching field is set.

      • getLatching

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

      • hasProcessOK

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

      • getProcessOK

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

      • hasTriggered

        boolean hasTriggered()
         triggered is same with processOK except when the alarm is latching
        optional bool triggered = 14;
        Returns:
        Whether the triggered field is set.

      • getTriggered

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

      • hasAcknowledged

        boolean hasAcknowledged()
         if the operator has acknowledged the alarm
        optional bool acknowledged = 15;
        Returns:
        Whether the acknowledged field is set.

      • getAcknowledged

        boolean getAcknowledged()
         if the operator has acknowledged the alarm
        optional bool acknowledged = 15;
        Returns:
        The acknowledged.

      • hasShelveInfo

        boolean hasShelveInfo()
         Details in case the alarm was shelved
        optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;
        Returns:
        Whether the shelveInfo field is set.

      • getShelveInfo

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

      • 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;
        Returns:
        Whether the clearInfo field is set.

      • getClearInfo

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

      • getClearInfoOrBuilder

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

      • hasUpdateTime

        boolean hasUpdateTime()
         Time when the alarm was last updated
        optional .google.protobuf.Timestamp updateTime = 18;
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Time when the alarm was last updated
        optional .google.protobuf.Timestamp updateTime = 18;
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Time when the alarm was last updated
        optional .google.protobuf.Timestamp updateTime = 18;