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| Modifier and Type | Method and Description |
|---|---|
AlarmData.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
AlarmData |
build() |
AlarmData |
buildPartial() |
AlarmData.Builder |
clear() |
AlarmData.Builder |
clearAcknowledged()
if the operator has acknowledged the alarm
optional bool acknowledged = 15; |
AlarmData.Builder |
clearAcknowledgeInfo()
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; |
AlarmData.Builder |
clearClearInfo()
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; |
AlarmData.Builder |
clearCount()
Number of samples received for the object
optional uint32 count = 7; |
AlarmData.Builder |
clearEventDetail()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; |
AlarmData.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
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; |
AlarmData.Builder |
clearLatching()
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12; |
AlarmData.Builder |
clearNotificationType()
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9; |
AlarmData.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
AlarmData.Builder |
clearParameterDetail()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; |
AlarmData.Builder |
clearProcessOK()
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13; |
AlarmData.Builder |
clearSeqNum()
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4; |
AlarmData.Builder |
clearSeverity()
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5; |
AlarmData.Builder |
clearShelveInfo()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; |
AlarmData.Builder |
clearTriggered()
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14; |
AlarmData.Builder |
clearTriggerTime()
optional .google.protobuf.Timestamp triggerTime = 2; |
AlarmData.Builder |
clearType()
optional .yamcs.protobuf.alarms.AlarmType type = 1; |
AlarmData.Builder |
clearViolations()
Number of times the object was in alarm state
optional uint32 violations = 6; |
AlarmData.Builder |
clone() |
boolean |
getAcknowledged()
if the operator has acknowledged the alarm
optional bool acknowledged = 15; |
AcknowledgeInfo |
getAcknowledgeInfo()
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; |
AcknowledgeInfo.Builder |
getAcknowledgeInfoBuilder()
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; |
ClearInfo.Builder |
getClearInfoBuilder()
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
optional uint32 count = 7; |
AlarmData |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
EventAlarmData |
getEventDetail()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; |
EventAlarmData.Builder |
getEventDetailBuilder()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; |
EventAlarmDataOrBuilder |
getEventDetailOrBuilder()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; |
Yamcs.NamedObjectId |
getId()
For parameter alarms, this is the id of the parameters
For event alarms
- the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless
EVENT_SOURCE starts with a "/" in which case the namespace
is just the <EVENT_SOURCE>
- the id.name is the <EVENT_TYPE>
optional .yamcs.protobuf.NamedObjectId id = 3; |
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; |
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; |
boolean |
getLatching()
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12; |
AlarmNotificationType |
getNotificationType()
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9; |
ParameterAlarmData |
getParameterDetail()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; |
ParameterAlarmData.Builder |
getParameterDetailBuilder()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; |
ParameterAlarmDataOrBuilder |
getParameterDetailOrBuilder()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; |
boolean |
getProcessOK()
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13; |
int |
getSeqNum()
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4; |
AlarmSeverity |
getSeverity()
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5; |
ShelveInfo |
getShelveInfo()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; |
ShelveInfo.Builder |
getShelveInfoBuilder()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; |
ShelveInfoOrBuilder |
getShelveInfoOrBuilder()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; |
boolean |
getTriggered()
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14; |
com.google.protobuf.Timestamp |
getTriggerTime()
optional .google.protobuf.Timestamp triggerTime = 2; |
com.google.protobuf.Timestamp.Builder |
getTriggerTimeBuilder()
optional .google.protobuf.Timestamp triggerTime = 2; |
com.google.protobuf.TimestampOrBuilder |
getTriggerTimeOrBuilder()
optional .google.protobuf.Timestamp triggerTime = 2; |
AlarmType |
getType()
optional .yamcs.protobuf.alarms.AlarmType type = 1; |
int |
getViolations()
Number of times the object was in alarm state
optional uint32 violations = 6; |
boolean |
hasAcknowledged()
if the operator has acknowledged the alarm
optional bool acknowledged = 15; |
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
optional uint32 count = 7; |
boolean |
hasEventDetail()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; |
boolean |
hasId()
For parameter alarms, this is the id of the parameters
For event alarms
- the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless
EVENT_SOURCE starts with a "/" in which case the namespace
is just the <EVENT_SOURCE>
- the id.name is the <EVENT_TYPE>
optional .yamcs.protobuf.NamedObjectId id = 3; |
boolean |
hasLatching()
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12; |
boolean |
hasNotificationType()
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9; |
boolean |
hasParameterDetail()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; |
boolean |
hasProcessOK()
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13; |
boolean |
hasSeqNum()
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4; |
boolean |
hasSeverity()
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5; |
boolean |
hasShelveInfo()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; |
boolean |
hasTriggered()
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14; |
boolean |
hasTriggerTime()
optional .google.protobuf.Timestamp triggerTime = 2; |
boolean |
hasType()
optional .yamcs.protobuf.alarms.AlarmType type = 1; |
boolean |
hasViolations()
Number of times the object was in alarm state
optional uint32 violations = 6; |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
AlarmData.Builder |
mergeAcknowledgeInfo(AcknowledgeInfo value)
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; |
AlarmData.Builder |
mergeClearInfo(ClearInfo value)
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; |
AlarmData.Builder |
mergeEventDetail(EventAlarmData value)
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; |
AlarmData.Builder |
mergeFrom(AlarmData other) |
AlarmData.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
AlarmData.Builder |
mergeFrom(com.google.protobuf.Message other) |
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; |
AlarmData.Builder |
mergeParameterDetail(ParameterAlarmData value)
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; |
AlarmData.Builder |
mergeShelveInfo(ShelveInfo value)
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; |
AlarmData.Builder |
mergeTriggerTime(com.google.protobuf.Timestamp value)
optional .google.protobuf.Timestamp triggerTime = 2; |
AlarmData.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
AlarmData.Builder |
setAcknowledged(boolean value)
if the operator has acknowledged the alarm
optional bool acknowledged = 15; |
AlarmData.Builder |
setAcknowledgeInfo(AcknowledgeInfo.Builder builderForValue)
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; |
AlarmData.Builder |
setAcknowledgeInfo(AcknowledgeInfo value)
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8; |
AlarmData.Builder |
setClearInfo(ClearInfo.Builder builderForValue)
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; |
AlarmData.Builder |
setClearInfo(ClearInfo value)
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17; |
AlarmData.Builder |
setCount(int value)
Number of samples received for the object
optional uint32 count = 7; |
AlarmData.Builder |
setEventDetail(EventAlarmData.Builder builderForValue)
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; |
AlarmData.Builder |
setEventDetail(EventAlarmData value)
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11; |
AlarmData.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
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; |
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; |
AlarmData.Builder |
setLatching(boolean value)
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12; |
AlarmData.Builder |
setNotificationType(AlarmNotificationType value)
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9; |
AlarmData.Builder |
setParameterDetail(ParameterAlarmData.Builder builderForValue)
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; |
AlarmData.Builder |
setParameterDetail(ParameterAlarmData value)
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10; |
AlarmData.Builder |
setProcessOK(boolean value)
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13; |
AlarmData.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
AlarmData.Builder |
setSeqNum(int value)
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4; |
AlarmData.Builder |
setSeverity(AlarmSeverity value)
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5; |
AlarmData.Builder |
setShelveInfo(ShelveInfo.Builder builderForValue)
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; |
AlarmData.Builder |
setShelveInfo(ShelveInfo value)
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16; |
AlarmData.Builder |
setTriggered(boolean value)
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14; |
AlarmData.Builder |
setTriggerTime(com.google.protobuf.Timestamp.Builder builderForValue)
optional .google.protobuf.Timestamp triggerTime = 2; |
AlarmData.Builder |
setTriggerTime(com.google.protobuf.Timestamp value)
optional .google.protobuf.Timestamp triggerTime = 2; |
AlarmData.Builder |
setType(AlarmType value)
optional .yamcs.protobuf.alarms.AlarmType type = 1; |
AlarmData.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
AlarmData.Builder |
setViolations(int value)
Number of times the object was in alarm state
optional uint32 violations = 6; |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic AlarmData build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic AlarmData buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic AlarmData.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<AlarmData.Builder>public AlarmData.Builder mergeFrom(AlarmData other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public AlarmData.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<AlarmData.Builder>IOExceptionpublic boolean hasType()
optional .yamcs.protobuf.alarms.AlarmType type = 1;hasType in interface AlarmDataOrBuilderpublic AlarmType getType()
optional .yamcs.protobuf.alarms.AlarmType type = 1;getType in interface AlarmDataOrBuilderpublic AlarmData.Builder setType(AlarmType value)
optional .yamcs.protobuf.alarms.AlarmType type = 1;public AlarmData.Builder clearType()
optional .yamcs.protobuf.alarms.AlarmType type = 1;public boolean hasTriggerTime()
optional .google.protobuf.Timestamp triggerTime = 2;hasTriggerTime in interface AlarmDataOrBuilderpublic com.google.protobuf.Timestamp getTriggerTime()
optional .google.protobuf.Timestamp triggerTime = 2;getTriggerTime in interface AlarmDataOrBuilderpublic AlarmData.Builder setTriggerTime(com.google.protobuf.Timestamp value)
optional .google.protobuf.Timestamp triggerTime = 2;public AlarmData.Builder setTriggerTime(com.google.protobuf.Timestamp.Builder builderForValue)
optional .google.protobuf.Timestamp triggerTime = 2;public AlarmData.Builder mergeTriggerTime(com.google.protobuf.Timestamp value)
optional .google.protobuf.Timestamp triggerTime = 2;public AlarmData.Builder clearTriggerTime()
optional .google.protobuf.Timestamp triggerTime = 2;public com.google.protobuf.Timestamp.Builder getTriggerTimeBuilder()
optional .google.protobuf.Timestamp triggerTime = 2;public com.google.protobuf.TimestampOrBuilder getTriggerTimeOrBuilder()
optional .google.protobuf.Timestamp triggerTime = 2;getTriggerTimeOrBuilder in interface AlarmDataOrBuilderpublic 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;hasId in interface AlarmDataOrBuilderpublic 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;getId in interface AlarmDataOrBuilderpublic 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;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;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;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;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;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;getIdOrBuilder in interface AlarmDataOrBuilderpublic boolean hasSeqNum()
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4;hasSeqNum in interface AlarmDataOrBuilderpublic int getSeqNum()
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4;getSeqNum in interface AlarmDataOrBuilderpublic AlarmData.Builder setSeqNum(int value)
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4;public AlarmData.Builder clearSeqNum()
Distinguisher between multiple alarms for the same id
optional uint32 seqNum = 4;public boolean hasSeverity()
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;hasSeverity in interface AlarmDataOrBuilderpublic AlarmSeverity getSeverity()
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;getSeverity in interface AlarmDataOrBuilderpublic AlarmData.Builder setSeverity(AlarmSeverity value)
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;public AlarmData.Builder clearSeverity()
optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;public boolean hasViolations()
Number of times the object was in alarm state
optional uint32 violations = 6;hasViolations in interface AlarmDataOrBuilderpublic int getViolations()
Number of times the object was in alarm state
optional uint32 violations = 6;getViolations in interface AlarmDataOrBuilderpublic AlarmData.Builder setViolations(int value)
Number of times the object was in alarm state
optional uint32 violations = 6;public AlarmData.Builder clearViolations()
Number of times the object was in alarm state
optional uint32 violations = 6;public boolean hasCount()
Number of samples received for the object
optional uint32 count = 7;hasCount in interface AlarmDataOrBuilderpublic int getCount()
Number of samples received for the object
optional uint32 count = 7;getCount in interface AlarmDataOrBuilderpublic AlarmData.Builder setCount(int value)
Number of samples received for the object
optional uint32 count = 7;public AlarmData.Builder clearCount()
Number of samples received for the object
optional uint32 count = 7;public boolean hasAcknowledgeInfo()
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;hasAcknowledgeInfo in interface AlarmDataOrBuilderpublic AcknowledgeInfo getAcknowledgeInfo()
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;getAcknowledgeInfo in interface AlarmDataOrBuilderpublic AlarmData.Builder setAcknowledgeInfo(AcknowledgeInfo value)
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;public AlarmData.Builder setAcknowledgeInfo(AcknowledgeInfo.Builder builderForValue)
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;public AlarmData.Builder mergeAcknowledgeInfo(AcknowledgeInfo value)
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;public AlarmData.Builder clearAcknowledgeInfo()
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;public AcknowledgeInfo.Builder getAcknowledgeInfoBuilder()
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;public AcknowledgeInfoOrBuilder getAcknowledgeInfoOrBuilder()
optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;getAcknowledgeInfoOrBuilder in interface AlarmDataOrBuilderpublic boolean hasNotificationType()
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;hasNotificationType in interface AlarmDataOrBuilderpublic AlarmNotificationType getNotificationType()
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;getNotificationType in interface AlarmDataOrBuilderpublic AlarmData.Builder setNotificationType(AlarmNotificationType value)
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;public AlarmData.Builder clearNotificationType()
optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;public boolean hasParameterDetail()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;hasParameterDetail in interface AlarmDataOrBuilderpublic ParameterAlarmData getParameterDetail()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;getParameterDetail in interface AlarmDataOrBuilderpublic AlarmData.Builder setParameterDetail(ParameterAlarmData value)
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;public AlarmData.Builder setParameterDetail(ParameterAlarmData.Builder builderForValue)
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;public AlarmData.Builder mergeParameterDetail(ParameterAlarmData value)
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;public AlarmData.Builder clearParameterDetail()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;public ParameterAlarmData.Builder getParameterDetailBuilder()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;public ParameterAlarmDataOrBuilder getParameterDetailOrBuilder()
optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;getParameterDetailOrBuilder in interface AlarmDataOrBuilderpublic boolean hasEventDetail()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;hasEventDetail in interface AlarmDataOrBuilderpublic EventAlarmData getEventDetail()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;getEventDetail in interface AlarmDataOrBuilderpublic AlarmData.Builder setEventDetail(EventAlarmData value)
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;public AlarmData.Builder setEventDetail(EventAlarmData.Builder builderForValue)
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;public AlarmData.Builder mergeEventDetail(EventAlarmData value)
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;public AlarmData.Builder clearEventDetail()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;public EventAlarmData.Builder getEventDetailBuilder()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;public EventAlarmDataOrBuilder getEventDetailOrBuilder()
optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;getEventDetailOrBuilder in interface AlarmDataOrBuilderpublic boolean hasLatching()
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12;hasLatching in interface AlarmDataOrBuilderpublic boolean getLatching()
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12;getLatching in interface AlarmDataOrBuilderpublic AlarmData.Builder setLatching(boolean value)
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12;public AlarmData.Builder clearLatching()
Whether the alarm will stay triggered even when the process is OK
optional bool latching = 12;public boolean hasProcessOK()
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13;hasProcessOK in interface AlarmDataOrBuilderpublic boolean getProcessOK()
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13;getProcessOK in interface AlarmDataOrBuilderpublic AlarmData.Builder setProcessOK(boolean value)
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13;public AlarmData.Builder clearProcessOK()
if the process that generated the alarm is ok (i.e. parameter is within limits)
optional bool processOK = 13;public boolean hasTriggered()
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14;hasTriggered in interface AlarmDataOrBuilderpublic boolean getTriggered()
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14;getTriggered in interface AlarmDataOrBuilderpublic AlarmData.Builder setTriggered(boolean value)
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14;public AlarmData.Builder clearTriggered()
triggered is same with processOK except when the alarm is latching
optional bool triggered = 14;public boolean hasAcknowledged()
if the operator has acknowledged the alarm
optional bool acknowledged = 15;hasAcknowledged in interface AlarmDataOrBuilderpublic boolean getAcknowledged()
if the operator has acknowledged the alarm
optional bool acknowledged = 15;getAcknowledged in interface AlarmDataOrBuilderpublic AlarmData.Builder setAcknowledged(boolean value)
if the operator has acknowledged the alarm
optional bool acknowledged = 15;public AlarmData.Builder clearAcknowledged()
if the operator has acknowledged the alarm
optional bool acknowledged = 15;public boolean hasShelveInfo()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;hasShelveInfo in interface AlarmDataOrBuilderpublic ShelveInfo getShelveInfo()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;getShelveInfo in interface AlarmDataOrBuilderpublic AlarmData.Builder setShelveInfo(ShelveInfo value)
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;public AlarmData.Builder setShelveInfo(ShelveInfo.Builder builderForValue)
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;public AlarmData.Builder mergeShelveInfo(ShelveInfo value)
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;public AlarmData.Builder clearShelveInfo()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;public ShelveInfo.Builder getShelveInfoBuilder()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;public ShelveInfoOrBuilder getShelveInfoOrBuilder()
Details in case the alarm was shelved
optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;getShelveInfoOrBuilder in interface AlarmDataOrBuilderpublic boolean hasClearInfo()
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;hasClearInfo in interface AlarmDataOrBuilderpublic ClearInfo getClearInfo()
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;getClearInfo in interface AlarmDataOrBuilderpublic AlarmData.Builder setClearInfo(ClearInfo value)
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;public AlarmData.Builder setClearInfo(ClearInfo.Builder builderForValue)
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;public AlarmData.Builder mergeClearInfo(ClearInfo value)
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;public AlarmData.Builder clearClearInfo()
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;public ClearInfo.Builder getClearInfoBuilder()
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;public ClearInfoOrBuilder getClearInfoOrBuilder()
optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;getClearInfoOrBuilder in interface AlarmDataOrBuilderpublic final AlarmData.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>public final AlarmData.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AlarmData.Builder>Copyright © 2022 Space Applications Services. All rights reserved.