org.yamcs.protobuf

Enum Alarms.AlarmNotificationType

java.lang.Object

java.lang.Enum<Alarms.AlarmNotificationType>

org.yamcs.protobuf.Alarms.AlarmNotificationType

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Alarms.AlarmNotificationType>

Enclosing class:

Alarms

public static enum Alarms.AlarmNotificationType
extends Enum<Alarms.AlarmNotificationType>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum yamcs.protobuf.alarms.AlarmNotificationType

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACKNOWLEDGED Whenever somebody acknowledged an alarm (it could be that it is still OOL) ACKNOWLEDGED = 5;
ACTIVE Initial active alarms at the moment of request ACTIVE = 1;
CLEARED When the alarm was really cleared by the server (acknowledged && not OOL) CLEARED = 6;
RESET when a latching alarm has been reset RESET = 10;
RTN When the parameter that triggered the alarm has returned to normal (the alarm may still be triggered if it has not been acknowledged) RTN = 7;
SEVERITY_INCREASED Whenever an alarm jumps severity SEVERITY_INCREASED = 3;
SHELVED when the alarm has been shelved SHELVED = 8;
TRIGGERED Whenever a new alarm triggers TRIGGERED = 2;
UNSHELVED when the alarm has been unshelved (either by operator request or automatically at timer expiration) UNSHELVED = 9;
VALUE_UPDATED Whenever a value is updated (even if that value is not a violation by itself) VALUE_UPDATED = 4;

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACKNOWLEDGED_VALUE Whenever somebody acknowledged an alarm (it could be that it is still OOL) ACKNOWLEDGED = 5;
static int	ACTIVE_VALUE Initial active alarms at the moment of request ACTIVE = 1;
static int	CLEARED_VALUE When the alarm was really cleared by the server (acknowledged && not OOL) CLEARED = 6;
static int	RESET_VALUE when a latching alarm has been reset RESET = 10;
static int	RTN_VALUE When the parameter that triggered the alarm has returned to normal (the alarm may still be triggered if it has not been acknowledged) RTN = 7;
static int	SEVERITY_INCREASED_VALUE Whenever an alarm jumps severity SEVERITY_INCREASED = 3;
static int	SHELVED_VALUE when the alarm has been shelved SHELVED = 8;
static int	TRIGGERED_VALUE Whenever a new alarm triggers TRIGGERED = 2;
static int	UNSHELVED_VALUE when the alarm has been unshelved (either by operator request or automatically at timer expiration) UNSHELVED = 9;
static int	VALUE_UPDATED_VALUE Whenever a value is updated (even if that value is not a violation by itself) VALUE_UPDATED = 4;

Method Summary

Modifier and Type	Method and Description
static Alarms.AlarmNotificationType	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Alarms.AlarmNotificationType>	internalGetValueMap()
static Alarms.AlarmNotificationType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Alarms.AlarmNotificationType	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Alarms.AlarmNotificationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Alarms.AlarmNotificationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTIVE

public static final Alarms.AlarmNotificationType ACTIVE

 Initial active alarms at the moment of request
 

ACTIVE = 1;

TRIGGERED

public static final Alarms.AlarmNotificationType TRIGGERED

 Whenever a new alarm triggers
 

TRIGGERED = 2;

SEVERITY_INCREASED

public static final Alarms.AlarmNotificationType SEVERITY_INCREASED

 Whenever an alarm jumps severity
 

SEVERITY_INCREASED = 3;

VALUE_UPDATED

public static final Alarms.AlarmNotificationType VALUE_UPDATED

 Whenever a value is updated (even if that value is not a violation by itself)
 

VALUE_UPDATED = 4;

ACKNOWLEDGED

public static final Alarms.AlarmNotificationType ACKNOWLEDGED

 Whenever somebody acknowledged an alarm (it could be that it is still OOL)
 

ACKNOWLEDGED = 5;

CLEARED

public static final Alarms.AlarmNotificationType CLEARED

 When the alarm was really cleared by the server (acknowledged && not OOL)
 

CLEARED = 6;

RTN

public static final Alarms.AlarmNotificationType RTN

 When the parameter that triggered the alarm has returned to normal (the alarm may still be triggered if it has not been acknowledged)
 

RTN = 7;

SHELVED

public static final Alarms.AlarmNotificationType SHELVED

when the alarm has been shelved
 

SHELVED = 8;

UNSHELVED

public static final Alarms.AlarmNotificationType UNSHELVED

when the alarm has been unshelved (either by operator request or automatically at timer expiration)
 

UNSHELVED = 9;

RESET

public static final Alarms.AlarmNotificationType RESET

when a latching alarm has been reset
 

RESET = 10;

Field Detail

ACTIVE_VALUE

public static final int ACTIVE_VALUE

 Initial active alarms at the moment of request
 

ACTIVE = 1;

See Also:

Constant Field Values

TRIGGERED_VALUE

public static final int TRIGGERED_VALUE

 Whenever a new alarm triggers
 

TRIGGERED = 2;

See Also:

Constant Field Values

SEVERITY_INCREASED_VALUE

public static final int SEVERITY_INCREASED_VALUE

 Whenever an alarm jumps severity
 

SEVERITY_INCREASED = 3;

See Also:

Constant Field Values

VALUE_UPDATED_VALUE

public static final int VALUE_UPDATED_VALUE

 Whenever a value is updated (even if that value is not a violation by itself)
 

VALUE_UPDATED = 4;

See Also:

Constant Field Values

ACKNOWLEDGED_VALUE

public static final int ACKNOWLEDGED_VALUE

 Whenever somebody acknowledged an alarm (it could be that it is still OOL)
 

ACKNOWLEDGED = 5;

See Also:

Constant Field Values

CLEARED_VALUE

public static final int CLEARED_VALUE

 When the alarm was really cleared by the server (acknowledged && not OOL)
 

CLEARED = 6;

See Also:

Constant Field Values

RTN_VALUE

public static final int RTN_VALUE

 When the parameter that triggered the alarm has returned to normal (the alarm may still be triggered if it has not been acknowledged)
 

RTN = 7;

See Also:

Constant Field Values

SHELVED_VALUE

public static final int SHELVED_VALUE

when the alarm has been shelved
 

SHELVED = 8;

See Also:

Constant Field Values

UNSHELVED_VALUE

public static final int UNSHELVED_VALUE

when the alarm has been unshelved (either by operator request or automatically at timer expiration)
 

UNSHELVED = 9;

See Also:

Constant Field Values

RESET_VALUE

public static final int RESET_VALUE

when a latching alarm has been reset
 

RESET = 10;

See Also:

Constant Field Values

Method Detail

values

public static Alarms.AlarmNotificationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Alarms.AlarmNotificationType c : Alarms.AlarmNotificationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Alarms.AlarmNotificationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static Alarms.AlarmNotificationType valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static Alarms.AlarmNotificationType forNumber(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<Alarms.AlarmNotificationType> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Alarms.AlarmNotificationType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)