Package org.yamcs.protobuf

Class AlarmData

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, AlarmDataOrBuilder
    public final class AlarmData
extends com.google.protobuf.GeneratedMessageV3
implements AlarmDataOrBuilder
     Summary of an alarm applicable for Parameter or Event (possibly
 other in the future) alarms.
 Contains detailed information on the value occurrence that initially
 triggered the alarm, the most severe value since it originally triggered,
 and the latest value at the time of your request.
    Protobuf type yamcs.protobuf.alarms.AlarmData
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasType

        public boolean hasType()
        optional .yamcs.protobuf.alarms.AlarmType type = 1;
        Specified by:
        hasType in interface AlarmDataOrBuilder
        Returns:
        Whether the type field is set.

      • hasTriggerTime

        public boolean hasTriggerTime()
        optional .google.protobuf.Timestamp triggerTime = 2;
        Specified by:
        hasTriggerTime in interface AlarmDataOrBuilder
        Returns:
        Whether the triggerTime field is set.

      • getTriggerTime

        public com.google.protobuf.Timestamp getTriggerTime()
        optional .google.protobuf.Timestamp triggerTime = 2;
        Specified by:
        getTriggerTime in interface AlarmDataOrBuilder
        Returns:
        The triggerTime.

      • getTriggerTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getTriggerTimeOrBuilder()
        optional .google.protobuf.Timestamp triggerTime = 2;
        Specified by:
        getTriggerTimeOrBuilder in interface AlarmDataOrBuilder

      • hasId

        public 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;
        Specified by:
        hasId in interface AlarmDataOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public 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;
        Specified by:
        getId in interface AlarmDataOrBuilder
        Returns:
        The id.

      • getIdOrBuilder

        public 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;
        Specified by:
        getIdOrBuilder in interface AlarmDataOrBuilder

      • hasSeqNum

        public boolean hasSeqNum()
         Distinguisher between multiple alarms for the same id
        optional uint32 seqNum = 4;
        Specified by:
        hasSeqNum in interface AlarmDataOrBuilder
        Returns:
        Whether the seqNum field is set.

      • getSeqNum

        public int getSeqNum()
         Distinguisher between multiple alarms for the same id
        optional uint32 seqNum = 4;
        Specified by:
        getSeqNum in interface AlarmDataOrBuilder
        Returns:
        The seqNum.

      • hasSeverity

        public boolean hasSeverity()
        optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
        Specified by:
        hasSeverity in interface AlarmDataOrBuilder
        Returns:
        Whether the severity field is set.

      • hasViolations

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

      • getViolations

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

      • hasCount

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

      • getCount

        public int getCount()
         Number of samples received for the object
        optional uint32 count = 7;
        Specified by:
        getCount in interface AlarmDataOrBuilder
        Returns:
        The count.

      • hasAcknowledgeInfo

        public boolean hasAcknowledgeInfo()
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
        Specified by:
        hasAcknowledgeInfo in interface AlarmDataOrBuilder
        Returns:
        Whether the acknowledgeInfo field is set.

      • hasNotificationType

        public boolean hasNotificationType()
        optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
        Specified by:
        hasNotificationType in interface AlarmDataOrBuilder
        Returns:
        Whether the notificationType field is set.

      • hasParameterDetail

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

      • getParameterDetail

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

      • hasEventDetail

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

      • getEventDetail

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

      • hasLatching

        public boolean hasLatching()
         Whether the alarm will stay triggered even when the process is OK
        optional bool latching = 12;
        Specified by:
        hasLatching in interface AlarmDataOrBuilder
        Returns:
        Whether the latching field is set.

      • getLatching

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

      • hasProcessOK

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

      • getProcessOK

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

      • hasTriggered

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

      • getTriggered

        public boolean getTriggered()
         triggered is same with processOK except when the alarm is latching
        optional bool triggered = 14;
        Specified by:
        getTriggered in interface AlarmDataOrBuilder
        Returns:
        The triggered.

      • hasAcknowledged

        public boolean hasAcknowledged()
         if the operator has acknowledged the alarm
        optional bool acknowledged = 15;
        Specified by:
        hasAcknowledged in interface AlarmDataOrBuilder
        Returns:
        Whether the acknowledged field is set.

      • getAcknowledged

        public boolean getAcknowledged()
         if the operator has acknowledged the alarm
        optional bool acknowledged = 15;
        Specified by:
        getAcknowledged in interface AlarmDataOrBuilder
        Returns:
        The acknowledged.

      • hasShelveInfo

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

      • getShelveInfo

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

      • hasClearInfo

        public boolean hasClearInfo()
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
        Specified by:
        hasClearInfo in interface AlarmDataOrBuilder
        Returns:
        Whether the clearInfo field is set.

      • hasUpdateTime

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

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Time when the alarm was last updated
        optional .google.protobuf.Timestamp updateTime = 18;
        Specified by:
        getUpdateTime in interface AlarmDataOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Time when the alarm was last updated
        optional .google.protobuf.Timestamp updateTime = 18;
        Specified by:
        getUpdateTimeOrBuilder in interface AlarmDataOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AlarmData parseFrom​(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlarmData parseFrom​(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlarmData parseFrom​(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlarmData parseFrom​(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlarmData parseFrom​(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlarmData parseFrom​(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlarmData parseFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Throws:
        IOException

      • newBuilderForType

        public AlarmData.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AlarmData.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AlarmData.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static AlarmData getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<AlarmData> parser()

      • getParserForType

        public com.google.protobuf.Parser<AlarmData> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AlarmData getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder