org.yamcs.protobuf

Interface AlarmDataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AlarmData, AlarmData.Builder

public interface AlarmDataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAcknowledged() if the operator has acknowledged the alarm optional bool acknowledged = 15;
AcknowledgeInfo	getAcknowledgeInfo() optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
AcknowledgeInfoOrBuilder	getAcknowledgeInfoOrBuilder() optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
ClearInfo	getClearInfo() optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
ClearInfoOrBuilder	getClearInfoOrBuilder() optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
int	getCount() this represents the number of samples received for the object optional uint32 count = 7;
EventAlarmData	getEventDetail() optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
EventAlarmDataOrBuilder	getEventDetailOrBuilder() optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
Yamcs.NamedObjectId	getId() for the parameter alarms, this is the id of the parameters for the event alarms - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless the 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 the parameter alarms, this is the id of the parameters for the event alarms - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless the 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() latching means that 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;
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() the sequence number allows to distinguish between multiple alarms for the same id optional uint32 seqNum = 4;
AlarmSeverity	getSeverity() optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
ShelveInfo	getShelveInfo() if the alarm is shelved, then this will be filled in with the shelving information optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;
ShelveInfoOrBuilder	getShelveInfoOrBuilder() if the alarm is shelved, then this will be filled in with the shelving information 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.TimestampOrBuilder	getTriggerTimeOrBuilder() optional .google.protobuf.Timestamp triggerTime = 2;
AlarmType	getType() optional .yamcs.protobuf.alarms.AlarmType type = 1;
int	getViolations() this represents the 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() this represents the number of samples received for the object optional uint32 count = 7;
boolean	hasEventDetail() optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
boolean	hasId() for the parameter alarms, this is the id of the parameters for the event alarms - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless the 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() latching means that 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() the sequence number allows to distinguish between multiple alarms for the same id optional uint32 seqNum = 4;
boolean	hasSeverity() optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
boolean	hasShelveInfo() if the alarm is shelved, then this will be filled in with the shelving information 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() this represents the number of times the object was in alarm state optional uint32 violations = 6;

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasType

boolean hasType()

optional .yamcs.protobuf.alarms.AlarmType type = 1;

getType

AlarmType getType()

optional .yamcs.protobuf.alarms.AlarmType type = 1;

hasTriggerTime

boolean hasTriggerTime()

optional .google.protobuf.Timestamp triggerTime = 2;

getTriggerTime

com.google.protobuf.Timestamp getTriggerTime()

optional .google.protobuf.Timestamp triggerTime = 2;

getTriggerTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getTriggerTimeOrBuilder()

optional .google.protobuf.Timestamp triggerTime = 2;

hasId

boolean hasId()

for the parameter alarms, this is the id of the parameters
 for the event alarms
   - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless the 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

Yamcs.NamedObjectId getId()

for the parameter alarms, this is the id of the parameters
 for the event alarms
   - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless the 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

Yamcs.NamedObjectIdOrBuilder getIdOrBuilder()

for the parameter alarms, this is the id of the parameters
 for the event alarms
   - the id.namespace is /yamcs/event/<EVENT_SOURCE>, unless the EVENT_SOURCE starts with a "/" in which case the namespace is just the <EVENT_SOURCE>
   - the id.name is the <EVENT_TYPE>
 

optional .yamcs.protobuf.NamedObjectId id = 3;

hasSeqNum

boolean hasSeqNum()

the sequence number allows to distinguish between multiple alarms for the same id
 

optional uint32 seqNum = 4;

getSeqNum

int getSeqNum()

the sequence number allows to distinguish between multiple alarms for the same id
 

optional uint32 seqNum = 4;

hasSeverity

boolean hasSeverity()

optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;

getSeverity

AlarmSeverity getSeverity()

optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;

hasViolations

boolean hasViolations()

this represents the number of times the object was in alarm state
 

optional uint32 violations = 6;

getViolations

int getViolations()

this represents the number of times the object was in alarm state
 

optional uint32 violations = 6;

hasCount

boolean hasCount()

this represents the number of samples received for the object
 

optional uint32 count = 7;

getCount

int getCount()

this represents the number of samples received for the object
 

optional uint32 count = 7;

hasAcknowledgeInfo

boolean hasAcknowledgeInfo()

optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

getAcknowledgeInfo

AcknowledgeInfo getAcknowledgeInfo()

optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

getAcknowledgeInfoOrBuilder

AcknowledgeInfoOrBuilder getAcknowledgeInfoOrBuilder()

optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;

hasNotificationType

boolean hasNotificationType()

optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;

getNotificationType

AlarmNotificationType getNotificationType()

optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;

hasParameterDetail

boolean hasParameterDetail()

optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

getParameterDetail

ParameterAlarmData getParameterDetail()

optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

getParameterDetailOrBuilder

ParameterAlarmDataOrBuilder getParameterDetailOrBuilder()

optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;

hasEventDetail

boolean hasEventDetail()

optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;

getEventDetail

EventAlarmData getEventDetail()

optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;

getEventDetailOrBuilder

EventAlarmDataOrBuilder getEventDetailOrBuilder()

optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;

hasLatching

boolean hasLatching()

latching means that the alarm will stay triggered even when the process is OK
 

optional bool latching = 12;

getLatching

boolean getLatching()

latching means that the alarm will stay triggered even when the process is OK
 

optional bool latching = 12;

hasProcessOK

boolean hasProcessOK()

 if the process that generated the alarm is ok (i.e. parameter is within limits)
 

optional bool processOK = 13;

getProcessOK

boolean getProcessOK()

 if the process that generated the alarm is ok (i.e. parameter is within limits)
 

optional bool processOK = 13;

hasTriggered

boolean hasTriggered()

 triggered is same with processOK except when the alarm is latching
 

optional bool triggered = 14;

getTriggered

boolean getTriggered()

 triggered is same with processOK except when the alarm is latching
 

optional bool triggered = 14;

hasAcknowledged

boolean hasAcknowledged()

 if the operator has acknowledged the alarm
 

optional bool acknowledged = 15;

getAcknowledged

boolean getAcknowledged()

 if the operator has acknowledged the alarm
 

optional bool acknowledged = 15;

hasShelveInfo

boolean hasShelveInfo()

if the alarm is shelved, then this will be filled in with the shelving information
 

optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

getShelveInfo

ShelveInfo getShelveInfo()

if the alarm is shelved, then this will be filled in with the shelving information
 

optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

getShelveInfoOrBuilder

ShelveInfoOrBuilder getShelveInfoOrBuilder()

if the alarm is shelved, then this will be filled in with the shelving information
 

optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;

hasClearInfo

boolean hasClearInfo()

optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;

getClearInfo

ClearInfo getClearInfo()

optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;

getClearInfoOrBuilder

ClearInfoOrBuilder getClearInfoOrBuilder()

optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;