java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
org.yamcs.protobuf.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 Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()if the operator has acknowledged the alarmoptional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;Number of samples received for the objectAdditional detail in case the alarm is of type EVENTclearField(com.google.protobuf.Descriptors.FieldDescriptor field) 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>Whether the alarm will stay triggered even when the process is OKoptional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Additional detail in case the alarm is of type PARAMETERAn alarm is in pending state if the minViolations has not been reached The alarm is not actually triggered in this case This is only sent when trueif the process that generated the alarm is ok (i.e. parameter is within limits)Whether this alarm may be updated by this processor.Distinguisher between multiple alarms for the same idoptional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;Details in case the alarm was shelvedtriggered is same with processOK except when the alarm is latchingoptional .google.protobuf.Timestamp triggerTime = 2;optional .yamcs.protobuf.alarms.AlarmType type = 1;Time when the alarm was last updatedNumber of times the object was in alarm stateclone()booleanif the operator has acknowledged the alarmoptional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;intgetCount()Number of samples received for the objectstatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorAdditional detail in case the alarm is of type EVENTAdditional detail in case the alarm is of type EVENTAdditional detail in case the alarm is of type EVENTgetId()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>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>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>booleanWhether the alarm will stay triggered even when the process is OKoptional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;Additional detail in case the alarm is of type PARAMETERAdditional detail in case the alarm is of type PARAMETERAdditional detail in case the alarm is of type PARAMETERbooleanAn alarm is in pending state if the minViolations has not been reached The alarm is not actually triggered in this case This is only sent when truebooleanif the process that generated the alarm is ok (i.e. parameter is within limits)booleanWhether this alarm may be updated by this processor.intDistinguisher between multiple alarms for the same idoptional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;Details in case the alarm was shelvedDetails in case the alarm was shelvedDetails in case the alarm was shelvedbooleantriggered is same with processOK except when the alarm is latchingcom.google.protobuf.Timestampoptional .google.protobuf.Timestamp triggerTime = 2;com.google.protobuf.Timestamp.Builderoptional .google.protobuf.Timestamp triggerTime = 2;com.google.protobuf.TimestampOrBuilderoptional .google.protobuf.Timestamp triggerTime = 2;getType()optional .yamcs.protobuf.alarms.AlarmType type = 1;com.google.protobuf.TimestampTime when the alarm was last updatedcom.google.protobuf.Timestamp.BuilderTime when the alarm was last updatedcom.google.protobuf.TimestampOrBuilderTime when the alarm was last updatedintNumber of times the object was in alarm statebooleanif the operator has acknowledged the alarmbooleanoptional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;booleanoptional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;booleanhasCount()Number of samples received for the objectbooleanAdditional detail in case the alarm is of type EVENTbooleanhasId()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>booleanWhether the alarm will stay triggered even when the process is OKbooleanoptional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;booleanAdditional detail in case the alarm is of type PARAMETERbooleanAn alarm is in pending state if the minViolations has not been reached The alarm is not actually triggered in this case This is only sent when truebooleanif the process that generated the alarm is ok (i.e. parameter is within limits)booleanWhether this alarm may be updated by this processor.booleanDistinguisher between multiple alarms for the same idbooleanoptional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;booleanDetails in case the alarm was shelvedbooleantriggered is same with processOK except when the alarm is latchingbooleanoptional .google.protobuf.Timestamp triggerTime = 2;booleanhasType()optional .yamcs.protobuf.alarms.AlarmType type = 1;booleanTime when the alarm was last updatedbooleanNumber of times the object was in alarm stateprotected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanoptional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;mergeClearInfo(ClearInfo value) optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;mergeEventDetail(EventAlarmData value) Additional detail in case the alarm is of type EVENTmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) 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>Additional detail in case the alarm is of type PARAMETERmergeShelveInfo(ShelveInfo value) Details in case the alarm was shelvedmergeTriggerTime(com.google.protobuf.Timestamp value) optional .google.protobuf.Timestamp triggerTime = 2;final AlarmData.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) mergeUpdateTime(com.google.protobuf.Timestamp value) Time when the alarm was last updatedsetAcknowledged(boolean value) if the operator has acknowledged the alarmoptional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;setAcknowledgeInfo(AcknowledgeInfo.Builder builderForValue) optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;setClearInfo(ClearInfo value) optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;setClearInfo(ClearInfo.Builder builderForValue) optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;setCount(int value) Number of samples received for the objectsetEventDetail(EventAlarmData value) Additional detail in case the alarm is of type EVENTsetEventDetail(EventAlarmData.Builder builderForValue) Additional detail in case the alarm is of type EVENTsetId(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>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>setLatching(boolean value) Whether the alarm will stay triggered even when the process is OKoptional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;Additional detail in case the alarm is of type PARAMETERsetParameterDetail(ParameterAlarmData.Builder builderForValue) Additional detail in case the alarm is of type PARAMETERsetPending(boolean value) An alarm is in pending state if the minViolations has not been reached The alarm is not actually triggered in this case This is only sent when truesetProcessOK(boolean value) if the process that generated the alarm is ok (i.e. parameter is within limits)setReadonly(boolean value) Whether this alarm may be updated by this processor.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setSeqNum(int value) Distinguisher between multiple alarms for the same idsetSeverity(AlarmSeverity value) optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;setShelveInfo(ShelveInfo value) Details in case the alarm was shelvedsetShelveInfo(ShelveInfo.Builder builderForValue) Details in case the alarm was shelvedsetTriggered(boolean value) triggered is same with processOK except when the alarm is latchingsetTriggerTime(com.google.protobuf.Timestamp value) optional .google.protobuf.Timestamp triggerTime = 2;setTriggerTime(com.google.protobuf.Timestamp.Builder builderForValue) optional .google.protobuf.Timestamp triggerTime = 2;optional .yamcs.protobuf.alarms.AlarmType type = 1;final AlarmData.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setUpdateTime(com.google.protobuf.Timestamp value) Time when the alarm was last updatedsetUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue) Time when the alarm was last updatedsetViolations(int value) Number of times the object was in alarm stateMethods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
setField
public AlarmData.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
setRepeatedField
public AlarmData.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
addRepeatedField
public AlarmData.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AlarmData.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AlarmData.Builder>- Throws:
IOException
-
hasType
public boolean hasType()optional .yamcs.protobuf.alarms.AlarmType type = 1;- Specified by:
hasTypein interfaceAlarmDataOrBuilder- Returns:
- Whether the type field is set.
-
getType
optional .yamcs.protobuf.alarms.AlarmType type = 1;- Specified by:
getTypein interfaceAlarmDataOrBuilder- Returns:
- The type.
-
setType
optional .yamcs.protobuf.alarms.AlarmType type = 1;- Parameters:
value- The type to set.- Returns:
- This builder for chaining.
-
clearType
optional .yamcs.protobuf.alarms.AlarmType type = 1;- Returns:
- This builder for chaining.
-
hasTriggerTime
public boolean hasTriggerTime()optional .google.protobuf.Timestamp triggerTime = 2;- Specified by:
hasTriggerTimein interfaceAlarmDataOrBuilder- Returns:
- Whether the triggerTime field is set.
-
getTriggerTime
public com.google.protobuf.Timestamp getTriggerTime()optional .google.protobuf.Timestamp triggerTime = 2;- Specified by:
getTriggerTimein interfaceAlarmDataOrBuilder- Returns:
- The triggerTime.
-
setTriggerTime
optional .google.protobuf.Timestamp triggerTime = 2; -
setTriggerTime
optional .google.protobuf.Timestamp triggerTime = 2; -
mergeTriggerTime
optional .google.protobuf.Timestamp triggerTime = 2; -
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:
getTriggerTimeOrBuilderin interfaceAlarmDataOrBuilder
-
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:
hasIdin interfaceAlarmDataOrBuilder- Returns:
- Whether the id field is set.
-
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:
getIdin interfaceAlarmDataOrBuilder- Returns:
- The id.
-
setId
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
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
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
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
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
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:
getIdOrBuilderin interfaceAlarmDataOrBuilder
-
hasSeqNum
public boolean hasSeqNum()Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4;- Specified by:
hasSeqNumin interfaceAlarmDataOrBuilder- 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:
getSeqNumin interfaceAlarmDataOrBuilder- Returns:
- The seqNum.
-
setSeqNum
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4;- Parameters:
value- The seqNum to set.- Returns:
- This builder for chaining.
-
clearSeqNum
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4;- Returns:
- This builder for chaining.
-
hasSeverity
public boolean hasSeverity()optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;- Specified by:
hasSeverityin interfaceAlarmDataOrBuilder- Returns:
- Whether the severity field is set.
-
getSeverity
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;- Specified by:
getSeverityin interfaceAlarmDataOrBuilder- Returns:
- The severity.
-
setSeverity
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;- Parameters:
value- The severity to set.- Returns:
- This builder for chaining.
-
clearSeverity
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;- Returns:
- This builder for chaining.
-
hasViolations
public boolean hasViolations()Number of times the object was in alarm state
optional uint32 violations = 6;- Specified by:
hasViolationsin interfaceAlarmDataOrBuilder- 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:
getViolationsin interfaceAlarmDataOrBuilder- Returns:
- The violations.
-
setViolations
Number of times the object was in alarm state
optional uint32 violations = 6;- Parameters:
value- The violations to set.- Returns:
- This builder for chaining.
-
clearViolations
Number of times the object was in alarm state
optional uint32 violations = 6;- Returns:
- This builder for chaining.
-
hasCount
public boolean hasCount()Number of samples received for the object
optional uint32 count = 7;- Specified by:
hasCountin interfaceAlarmDataOrBuilder- Returns:
- Whether the count field is set.
-
getCount
public int getCount()Number of samples received for the object
optional uint32 count = 7;- Specified by:
getCountin interfaceAlarmDataOrBuilder- Returns:
- The count.
-
setCount
Number of samples received for the object
optional uint32 count = 7;- Parameters:
value- The count to set.- Returns:
- This builder for chaining.
-
clearCount
Number of samples received for the object
optional uint32 count = 7;- Returns:
- This builder for chaining.
-
hasAcknowledgeInfo
public boolean hasAcknowledgeInfo()optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;- Specified by:
hasAcknowledgeInfoin interfaceAlarmDataOrBuilder- Returns:
- Whether the acknowledgeInfo field is set.
-
getAcknowledgeInfo
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;- Specified by:
getAcknowledgeInfoin interfaceAlarmDataOrBuilder- Returns:
- The acknowledgeInfo.
-
setAcknowledgeInfo
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; -
setAcknowledgeInfo
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; -
mergeAcknowledgeInfo
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; -
clearAcknowledgeInfo
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; -
getAcknowledgeInfoBuilder
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; -
getAcknowledgeInfoOrBuilder
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;- Specified by:
getAcknowledgeInfoOrBuilderin interfaceAlarmDataOrBuilder
-
hasNotificationType
public boolean hasNotificationType()optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;- Specified by:
hasNotificationTypein interfaceAlarmDataOrBuilder- Returns:
- Whether the notificationType field is set.
-
getNotificationType
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;- Specified by:
getNotificationTypein interfaceAlarmDataOrBuilder- Returns:
- The notificationType.
-
setNotificationType
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;- Parameters:
value- The notificationType to set.- Returns:
- This builder for chaining.
-
clearNotificationType
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;- Returns:
- This builder for chaining.
-
hasParameterDetail
public boolean hasParameterDetail()Additional detail in case the alarm is of type PARAMETER
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;- Specified by:
hasParameterDetailin interfaceAlarmDataOrBuilder- Returns:
- Whether the parameterDetail field is set.
-
getParameterDetail
Additional detail in case the alarm is of type PARAMETER
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;- Specified by:
getParameterDetailin interfaceAlarmDataOrBuilder- Returns:
- The parameterDetail.
-
setParameterDetail
Additional detail in case the alarm is of type PARAMETER
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; -
setParameterDetail
Additional detail in case the alarm is of type PARAMETER
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; -
mergeParameterDetail
Additional detail in case the alarm is of type PARAMETER
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; -
clearParameterDetail
Additional detail in case the alarm is of type PARAMETER
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; -
getParameterDetailBuilder
Additional detail in case the alarm is of type PARAMETER
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; -
getParameterDetailOrBuilder
Additional detail in case the alarm is of type PARAMETER
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;- Specified by:
getParameterDetailOrBuilderin interfaceAlarmDataOrBuilder
-
hasEventDetail
public boolean hasEventDetail()Additional detail in case the alarm is of type EVENT
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;- Specified by:
hasEventDetailin interfaceAlarmDataOrBuilder- Returns:
- Whether the eventDetail field is set.
-
getEventDetail
Additional detail in case the alarm is of type EVENT
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;- Specified by:
getEventDetailin interfaceAlarmDataOrBuilder- Returns:
- The eventDetail.
-
setEventDetail
Additional detail in case the alarm is of type EVENT
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; -
setEventDetail
Additional detail in case the alarm is of type EVENT
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; -
mergeEventDetail
Additional detail in case the alarm is of type EVENT
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; -
clearEventDetail
Additional detail in case the alarm is of type EVENT
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; -
getEventDetailBuilder
Additional detail in case the alarm is of type EVENT
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; -
getEventDetailOrBuilder
Additional detail in case the alarm is of type EVENT
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;- Specified by:
getEventDetailOrBuilderin interfaceAlarmDataOrBuilder
-
hasLatching
public boolean hasLatching()Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12;- Specified by:
hasLatchingin interfaceAlarmDataOrBuilder- 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:
getLatchingin interfaceAlarmDataOrBuilder- Returns:
- The latching.
-
setLatching
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12;- Parameters:
value- The latching to set.- Returns:
- This builder for chaining.
-
clearLatching
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12;- Returns:
- This builder for chaining.
-
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:
hasProcessOKin interfaceAlarmDataOrBuilder- 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:
getProcessOKin interfaceAlarmDataOrBuilder- Returns:
- The processOK.
-
setProcessOK
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13;- Parameters:
value- The processOK to set.- Returns:
- This builder for chaining.
-
clearProcessOK
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13;- Returns:
- This builder for chaining.
-
hasTriggered
public boolean hasTriggered()triggered is same with processOK except when the alarm is latching
optional bool triggered = 14;- Specified by:
hasTriggeredin interfaceAlarmDataOrBuilder- 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:
getTriggeredin interfaceAlarmDataOrBuilder- Returns:
- The triggered.
-
setTriggered
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14;- Parameters:
value- The triggered to set.- Returns:
- This builder for chaining.
-
clearTriggered
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14;- Returns:
- This builder for chaining.
-
hasAcknowledged
public boolean hasAcknowledged()if the operator has acknowledged the alarm
optional bool acknowledged = 15;- Specified by:
hasAcknowledgedin interfaceAlarmDataOrBuilder- Returns:
- Whether the acknowledged field is set.
-
getAcknowledged
public boolean getAcknowledged()if the operator has acknowledged the alarm
optional bool acknowledged = 15;- Specified by:
getAcknowledgedin interfaceAlarmDataOrBuilder- Returns:
- The acknowledged.
-
setAcknowledged
if the operator has acknowledged the alarm
optional bool acknowledged = 15;- Parameters:
value- The acknowledged to set.- Returns:
- This builder for chaining.
-
clearAcknowledged
if the operator has acknowledged the alarm
optional bool acknowledged = 15;- Returns:
- This builder for chaining.
-
hasShelveInfo
public boolean hasShelveInfo()Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;- Specified by:
hasShelveInfoin interfaceAlarmDataOrBuilder- Returns:
- Whether the shelveInfo field is set.
-
getShelveInfo
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;- Specified by:
getShelveInfoin interfaceAlarmDataOrBuilder- Returns:
- The shelveInfo.
-
setShelveInfo
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; -
setShelveInfo
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; -
mergeShelveInfo
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; -
clearShelveInfo
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; -
getShelveInfoBuilder
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; -
getShelveInfoOrBuilder
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;- Specified by:
getShelveInfoOrBuilderin interfaceAlarmDataOrBuilder
-
hasClearInfo
public boolean hasClearInfo()optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;- Specified by:
hasClearInfoin interfaceAlarmDataOrBuilder- Returns:
- Whether the clearInfo field is set.
-
getClearInfo
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;- Specified by:
getClearInfoin interfaceAlarmDataOrBuilder- Returns:
- The clearInfo.
-
setClearInfo
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; -
setClearInfo
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; -
mergeClearInfo
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; -
clearClearInfo
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; -
getClearInfoBuilder
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; -
getClearInfoOrBuilder
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;- Specified by:
getClearInfoOrBuilderin interfaceAlarmDataOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Time when the alarm was last updated
optional .google.protobuf.Timestamp updateTime = 18;- Specified by:
hasUpdateTimein interfaceAlarmDataOrBuilder- 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:
getUpdateTimein interfaceAlarmDataOrBuilder- Returns:
- The updateTime.
-
setUpdateTime
Time when the alarm was last updated
optional .google.protobuf.Timestamp updateTime = 18; -
setUpdateTime
Time when the alarm was last updated
optional .google.protobuf.Timestamp updateTime = 18; -
mergeUpdateTime
Time when the alarm was last updated
optional .google.protobuf.Timestamp updateTime = 18; -
clearUpdateTime
Time when the alarm was last updated
optional .google.protobuf.Timestamp updateTime = 18; -
getUpdateTimeBuilder
public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()Time when the alarm was last updated
optional .google.protobuf.Timestamp updateTime = 18; -
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Time when the alarm was last updated
optional .google.protobuf.Timestamp updateTime = 18;- Specified by:
getUpdateTimeOrBuilderin interfaceAlarmDataOrBuilder
-
hasReadonly
public boolean hasReadonly()Whether this alarm may be updated by this processor. Set to false when the alarms are mirrored from another Yamcs instance.
optional bool readonly = 19;- Specified by:
hasReadonlyin interfaceAlarmDataOrBuilder- Returns:
- Whether the readonly field is set.
-
getReadonly
public boolean getReadonly()Whether this alarm may be updated by this processor. Set to false when the alarms are mirrored from another Yamcs instance.
optional bool readonly = 19;- Specified by:
getReadonlyin interfaceAlarmDataOrBuilder- Returns:
- The readonly.
-
setReadonly
Whether this alarm may be updated by this processor. Set to false when the alarms are mirrored from another Yamcs instance.
optional bool readonly = 19;- Parameters:
value- The readonly to set.- Returns:
- This builder for chaining.
-
clearReadonly
Whether this alarm may be updated by this processor. Set to false when the alarms are mirrored from another Yamcs instance.
optional bool readonly = 19;- Returns:
- This builder for chaining.
-
hasPending
public boolean hasPending()An alarm is in pending state if the minViolations has not been reached The alarm is not actually triggered in this case This is only sent when true
optional bool pending = 20;- Specified by:
hasPendingin interfaceAlarmDataOrBuilder- Returns:
- Whether the pending field is set.
-
getPending
public boolean getPending()An alarm is in pending state if the minViolations has not been reached The alarm is not actually triggered in this case This is only sent when true
optional bool pending = 20;- Specified by:
getPendingin interfaceAlarmDataOrBuilder- Returns:
- The pending.
-
setPending
An alarm is in pending state if the minViolations has not been reached The alarm is not actually triggered in this case This is only sent when true
optional bool pending = 20;- Parameters:
value- The pending to set.- Returns:
- This builder for chaining.
-
clearPending
An alarm is in pending state if the minViolations has not been reached The alarm is not actually triggered in this case This is only sent when true
optional bool pending = 20;- Returns:
- This builder for chaining.
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-
mergeUnknownFields
public final AlarmData.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>
-