org.yamcs.protobuf.AlarmDataOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: yamcs/protobuf/alarms/alarms.proto
package org.yamcs.protobuf;
public interface AlarmDataOrBuilder extends
// @@protoc_insertion_point(interface_extends:yamcs.protobuf.alarms.AlarmData)
com.google.protobuf.MessageOrBuilder {
/**
* optional .yamcs.protobuf.alarms.AlarmType type = 1;
* @return Whether the type field is set.
*/
boolean hasType();
/**
* optional .yamcs.protobuf.alarms.AlarmType type = 1;
* @return The type.
*/
org.yamcs.protobuf.AlarmType getType();
/**
* optional .google.protobuf.Timestamp triggerTime = 2;
* @return Whether the triggerTime field is set.
*/
boolean hasTriggerTime();
/**
* optional .google.protobuf.Timestamp triggerTime = 2;
* @return The triggerTime.
*/
com.google.protobuf.Timestamp getTriggerTime();
/**
* optional .google.protobuf.Timestamp triggerTime = 2;
*/
com.google.protobuf.TimestampOrBuilder getTriggerTimeOrBuilder();
/**
*
* 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;
* @return Whether the id field is set.
*/
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;
* @return The id.
*/
org.yamcs.protobuf.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;
*/
org.yamcs.protobuf.Yamcs.NamedObjectIdOrBuilder getIdOrBuilder();
/**
*
* Distinguisher between multiple alarms for the same id
*
*
* optional uint32 seqNum = 4;
* @return Whether the seqNum field is set.
*/
boolean hasSeqNum();
/**
*
* Distinguisher between multiple alarms for the same id
*
*
* optional uint32 seqNum = 4;
* @return The seqNum.
*/
int getSeqNum();
/**
* optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
* @return Whether the severity field is set.
*/
boolean hasSeverity();
/**
* optional .yamcs.protobuf.alarms.AlarmSeverity severity = 5;
* @return The severity.
*/
org.yamcs.protobuf.AlarmSeverity getSeverity();
/**
*
* Number of times the object was in alarm state
*
*
* optional uint32 violations = 6;
* @return Whether the violations field is set.
*/
boolean hasViolations();
/**
*
* Number of times the object was in alarm state
*
*
* optional uint32 violations = 6;
* @return The violations.
*/
int getViolations();
/**
*
* Number of samples received for the object
*
*
* optional uint32 count = 7;
* @return Whether the count field is set.
*/
boolean hasCount();
/**
*
* Number of samples received for the object
*
*
* optional uint32 count = 7;
* @return The count.
*/
int getCount();
/**
* optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
* @return Whether the acknowledgeInfo field is set.
*/
boolean hasAcknowledgeInfo();
/**
* optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
* @return The acknowledgeInfo.
*/
org.yamcs.protobuf.AcknowledgeInfo getAcknowledgeInfo();
/**
* optional .yamcs.protobuf.alarms.AcknowledgeInfo acknowledgeInfo = 8;
*/
org.yamcs.protobuf.AcknowledgeInfoOrBuilder getAcknowledgeInfoOrBuilder();
/**
* optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
* @return Whether the notificationType field is set.
*/
boolean hasNotificationType();
/**
* optional .yamcs.protobuf.alarms.AlarmNotificationType notificationType = 9;
* @return The notificationType.
*/
org.yamcs.protobuf.AlarmNotificationType getNotificationType();
/**
*
* Additional detail in case the alarm is of type PARAMETER
*
*
* optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
* @return Whether the parameterDetail field is set.
*/
boolean hasParameterDetail();
/**
*
* Additional detail in case the alarm is of type PARAMETER
*
*
* optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
* @return The parameterDetail.
*/
org.yamcs.protobuf.ParameterAlarmData getParameterDetail();
/**
*
* Additional detail in case the alarm is of type PARAMETER
*
*
* optional .yamcs.protobuf.alarms.ParameterAlarmData parameterDetail = 10;
*/
org.yamcs.protobuf.ParameterAlarmDataOrBuilder getParameterDetailOrBuilder();
/**
*
* Additional detail in case the alarm is of type EVENT
*
*
* optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
* @return Whether the eventDetail field is set.
*/
boolean hasEventDetail();
/**
*
* Additional detail in case the alarm is of type EVENT
*
*
* optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
* @return The eventDetail.
*/
org.yamcs.protobuf.EventAlarmData getEventDetail();
/**
*
* Additional detail in case the alarm is of type EVENT
*
*
* optional .yamcs.protobuf.alarms.EventAlarmData eventDetail = 11;
*/
org.yamcs.protobuf.EventAlarmDataOrBuilder getEventDetailOrBuilder();
/**
*
* Whether the alarm will stay triggered even when the process is OK
*
*
* optional bool latching = 12;
* @return Whether the latching field is set.
*/
boolean hasLatching();
/**
*
* Whether the alarm will stay triggered even when the process is OK
*
*
* optional bool latching = 12;
* @return The latching.
*/
boolean getLatching();
/**
*
* if the process that generated the alarm is ok (i.e. parameter is within limits)
*
*
* optional bool processOK = 13;
* @return Whether the processOK field is set.
*/
boolean hasProcessOK();
/**
*
* if the process that generated the alarm is ok (i.e. parameter is within limits)
*
*
* optional bool processOK = 13;
* @return The processOK.
*/
boolean getProcessOK();
/**
*
* triggered is same with processOK except when the alarm is latching
*
*
* optional bool triggered = 14;
* @return Whether the triggered field is set.
*/
boolean hasTriggered();
/**
*
* triggered is same with processOK except when the alarm is latching
*
*
* optional bool triggered = 14;
* @return The triggered.
*/
boolean getTriggered();
/**
*
* if the operator has acknowledged the alarm
*
*
* optional bool acknowledged = 15;
* @return Whether the acknowledged field is set.
*/
boolean hasAcknowledged();
/**
*
* if the operator has acknowledged the alarm
*
*
* optional bool acknowledged = 15;
* @return The acknowledged.
*/
boolean getAcknowledged();
/**
*
* Details in case the alarm was shelved
*
*
* optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;
* @return Whether the shelveInfo field is set.
*/
boolean hasShelveInfo();
/**
*
* Details in case the alarm was shelved
*
*
* optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;
* @return The shelveInfo.
*/
org.yamcs.protobuf.ShelveInfo getShelveInfo();
/**
*
* Details in case the alarm was shelved
*
*
* optional .yamcs.protobuf.alarms.ShelveInfo shelveInfo = 16;
*/
org.yamcs.protobuf.ShelveInfoOrBuilder getShelveInfoOrBuilder();
/**
* optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
* @return Whether the clearInfo field is set.
*/
boolean hasClearInfo();
/**
* optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
* @return The clearInfo.
*/
org.yamcs.protobuf.ClearInfo getClearInfo();
/**
* optional .yamcs.protobuf.alarms.ClearInfo clearInfo = 17;
*/
org.yamcs.protobuf.ClearInfoOrBuilder getClearInfoOrBuilder();
/**
*
* Time when the alarm was last updated
*
*
* optional .google.protobuf.Timestamp updateTime = 18;
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
* Time when the alarm was last updated
*
*
* optional .google.protobuf.Timestamp updateTime = 18;
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
* Time when the alarm was last updated
*
*
* optional .google.protobuf.Timestamp updateTime = 18;
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
* 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;
* @return Whether the readonly field is set.
*/
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;
* @return The readonly.
*/
boolean getReadonly();
/**
*
* 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;
* @return Whether the pending field is set.
*/
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;
* @return The pending.
*/
boolean getPending();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy