Package org.yamcs.protobuf

Class AlarmData.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, AlarmDataOrBuilder
    Enclosing class:
    AlarmData
    public static final class AlarmData.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
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

    • Method Detail

      • 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.Builder<AlarmData.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public AlarmData.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>

      • clearField

        public AlarmData.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>

      • clearOneof

        public AlarmData.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>

      • setRepeatedField

        public AlarmData.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>

      • addRepeatedField

        public AlarmData.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>

      • mergeFrom

        public AlarmData.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AlarmData.Builder>

      • isInitialized

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

      • mergeFrom

        public AlarmData.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AlarmData.Builder>
        Throws:
        IOException

      • hasType

        public boolean hasType()
        optional .yamcs.protobuf.alarms.AlarmType type = 1;
        Specified by:
        hasType in interface AlarmDataOrBuilder

      • clearType

        public AlarmData.Builder clearType()
        optional .yamcs.protobuf.alarms.AlarmType type = 1;

      • hasTriggerTime

        public boolean hasTriggerTime()
        optional .google.protobuf.Timestamp triggerTime = 2;
        Specified by:
        hasTriggerTime in interface AlarmDataOrBuilder

      • getTriggerTime

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

      • setTriggerTime

        public AlarmData.Builder setTriggerTime​(com.google.protobuf.Timestamp value)
        optional .google.protobuf.Timestamp triggerTime = 2;

      • setTriggerTime

        public AlarmData.Builder setTriggerTime​(com.google.protobuf.Timestamp.Builder builderForValue)
        optional .google.protobuf.Timestamp triggerTime = 2;

      • mergeTriggerTime

        public AlarmData.Builder mergeTriggerTime​(com.google.protobuf.Timestamp value)
        optional .google.protobuf.Timestamp triggerTime = 2;

      • clearTriggerTime

        public AlarmData.Builder clearTriggerTime()
        optional .google.protobuf.Timestamp triggerTime = 2;

      • getTriggerTimeBuilder

        public com.google.protobuf.Timestamp.Builder getTriggerTimeBuilder()
        optional .google.protobuf.Timestamp triggerTime = 2;

      • 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

      • 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

      • setId

        public AlarmData.Builder setId​(Yamcs.NamedObjectId value)
         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;

      • setId

        public AlarmData.Builder setId​(Yamcs.NamedObjectId.Builder builderForValue)
         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;

      • mergeId

        public AlarmData.Builder mergeId​(Yamcs.NamedObjectId value)
         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;

      • clearId

        public AlarmData.Builder clearId()
         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;

      • getIdBuilder

        public Yamcs.NamedObjectId.Builder getIdBuilder()
         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

        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

      • getSeqNum

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

      • setSeqNum

        public AlarmData.Builder setSeqNum​(int value)
         Distinguisher between multiple alarms for the same id
        optional uint32 seqNum = 4;

      • clearSeqNum

        public AlarmData.Builder clearSeqNum()
         Distinguisher between multiple alarms for the same id
        optional uint32 seqNum = 4;

      • hasSeverity

        public boolean hasSeverity()
        optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
        Specified by:
        hasSeverity in interface AlarmDataOrBuilder

      • clearSeverity

        public AlarmData.Builder clearSeverity()
        optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;

      • hasViolations

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

      • getViolations

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

      • setViolations

        public AlarmData.Builder setViolations​(int value)
         Number of times the object was in alarm state
        optional uint32 violations = 6;

      • clearViolations

        public AlarmData.Builder clearViolations()
         Number of times the object was in alarm state
        optional uint32 violations = 6;

      • hasCount

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

      • getCount

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

      • setCount

        public AlarmData.Builder setCount​(int value)
         Number of samples received for the object
        optional uint32 count = 7;

      • clearCount

        public AlarmData.Builder clearCount()
         Number of samples received for the object
        optional uint32 count = 7;

      • hasAcknowledgeInfo

        public boolean hasAcknowledgeInfo()
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
        Specified by:
        hasAcknowledgeInfo in interface AlarmDataOrBuilder

      • setAcknowledgeInfo

        public AlarmData.Builder setAcknowledgeInfo​(AcknowledgeInfo value)
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

      • mergeAcknowledgeInfo

        public AlarmData.Builder mergeAcknowledgeInfo​(AcknowledgeInfo value)
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

      • clearAcknowledgeInfo

        public AlarmData.Builder clearAcknowledgeInfo()
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

      • getAcknowledgeInfoBuilder

        public AcknowledgeInfo.Builder getAcknowledgeInfoBuilder()
        optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

      • hasNotificationType

        public boolean hasNotificationType()
        optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
        Specified by:
        hasNotificationType in interface AlarmDataOrBuilder

      • clearNotificationType

        public AlarmData.Builder clearNotificationType()
        optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;

      • hasParameterDetail

        public boolean hasParameterDetail()
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
        Specified by:
        hasParameterDetail in interface AlarmDataOrBuilder

      • clearParameterDetail

        public AlarmData.Builder clearParameterDetail()
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

      • getParameterDetailBuilder

        public ParameterAlarmData.Builder getParameterDetailBuilder()
        optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

      • hasEventDetail

        public boolean hasEventDetail()
        optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
        Specified by:
        hasEventDetail in interface AlarmDataOrBuilder

      • clearEventDetail

        public AlarmData.Builder clearEventDetail()
        optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;

      • getEventDetailBuilder

        public EventAlarmData.Builder getEventDetailBuilder()
        optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;

      • 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

      • 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

      • setLatching

        public AlarmData.Builder setLatching​(boolean value)
         Whether the alarm will stay triggered even when the process is OK
        optional bool latching = 12;

      • clearLatching

        public AlarmData.Builder clearLatching()
         Whether the alarm will stay triggered even when the process is OK
        optional bool latching = 12;

      • 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

      • 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

      • setProcessOK

        public AlarmData.Builder setProcessOK​(boolean value)
         if the process that generated the alarm is ok (i.e. parameter is within limits)
        optional bool processOK = 13;

      • clearProcessOK

        public AlarmData.Builder clearProcessOK()
         if the process that generated the alarm is ok (i.e. parameter is within limits)
        optional bool processOK = 13;

      • 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

      • 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

      • setTriggered

        public AlarmData.Builder setTriggered​(boolean value)
         triggered is same with processOK except when the alarm is latching
        optional bool triggered = 14;

      • clearTriggered

        public AlarmData.Builder clearTriggered()
         triggered is same with processOK except when the alarm is latching
        optional bool triggered = 14;

      • hasAcknowledged

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

      • getAcknowledged

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

      • setAcknowledged

        public AlarmData.Builder setAcknowledged​(boolean value)
         if the operator has acknowledged the alarm
        optional bool acknowledged = 15;

      • clearAcknowledged

        public AlarmData.Builder clearAcknowledged()
         if the operator has acknowledged the alarm
        optional bool acknowledged = 15;

      • hasShelveInfo

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

      • getShelveInfo

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

      • setShelveInfo

        public AlarmData.Builder setShelveInfo​(ShelveInfo value)
         Details in case the alarm was shelved
        optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

      • setShelveInfo

        public AlarmData.Builder setShelveInfo​(ShelveInfo.Builder builderForValue)
         Details in case the alarm was shelved
        optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

      • mergeShelveInfo

        public AlarmData.Builder mergeShelveInfo​(ShelveInfo value)
         Details in case the alarm was shelved
        optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

      • clearShelveInfo

        public AlarmData.Builder clearShelveInfo()
         Details in case the alarm was shelved
        optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

      • getShelveInfoBuilder

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

      • hasClearInfo

        public boolean hasClearInfo()
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
        Specified by:
        hasClearInfo in interface AlarmDataOrBuilder

      • setClearInfo

        public AlarmData.Builder setClearInfo​(ClearInfo value)
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;

      • mergeClearInfo

        public AlarmData.Builder mergeClearInfo​(ClearInfo value)
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;

      • clearClearInfo

        public AlarmData.Builder clearClearInfo()
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;

      • getClearInfoBuilder

        public ClearInfo.Builder getClearInfoBuilder()
        optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;

      • setUnknownFields

        public final AlarmData.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>

      • mergeUnknownFields

        public final AlarmData.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>