org.yamcs.protobuf

Interface Alarms.AlarmDataOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Alarms.AlarmData, Alarms.AlarmData.Builder

Enclosing class:

Alarms

public static interface Alarms.AlarmDataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Alarms.AcknowledgeInfo	getAcknowledgeInfo() optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
Alarms.AcknowledgeInfoOrBuilder	getAcknowledgeInfoOrBuilder() optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
int	getCount() this represents the number of samples received for the object
Alarms.EventAlarmData	getEventDetail() optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
Alarms.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>
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>
Alarms.AlarmNotificationType	getNotificationType() optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
Alarms.ParameterAlarmData	getParameterDetail() optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
Alarms.ParameterAlarmDataOrBuilder	getParameterDetailOrBuilder() optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
int	getSeqNum() the sequence number allows to distinguish between multiple alarms for the same id
Alarms.AlarmSeverity	getSeverity() optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
com.google.protobuf.Timestamp	getTriggerTime() optional .google.protobuf.Timestamp triggerTime = 2;
com.google.protobuf.TimestampOrBuilder	getTriggerTimeOrBuilder() optional .google.protobuf.Timestamp triggerTime = 2;
Alarms.AlarmType	getType() optional .yamcs.protobuf.alarms.AlarmType type = 1;
int	getViolations() this represents the number of times the object was in alarm state
boolean	hasAcknowledgeInfo() optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
boolean	hasCount() this represents the number of samples received for the object
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>
boolean	hasNotificationType() optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
boolean	hasParameterDetail() optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
boolean	hasSeqNum() the sequence number allows to distinguish between multiple alarms for the same id
boolean	hasSeverity() optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
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

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

Alarms.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

Alarms.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

Alarms.AcknowledgeInfo getAcknowledgeInfo()

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

getAcknowledgeInfoOrBuilder

Alarms.AcknowledgeInfoOrBuilder getAcknowledgeInfoOrBuilder()

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

hasNotificationType

boolean hasNotificationType()

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

getNotificationType

Alarms.AlarmNotificationType getNotificationType()

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

hasParameterDetail

boolean hasParameterDetail()

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

getParameterDetail

Alarms.ParameterAlarmData getParameterDetail()

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

getParameterDetailOrBuilder

Alarms.ParameterAlarmDataOrBuilder getParameterDetailOrBuilder()

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

hasEventDetail

boolean hasEventDetail()

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

getEventDetail

Alarms.EventAlarmData getEventDetail()

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

getEventDetailOrBuilder

Alarms.EventAlarmDataOrBuilder getEventDetailOrBuilder()

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