Enum Class AlarmEnumsProto.AlarmStateTransitionPB
java.lang.Object
java.lang.Enum<AlarmEnumsProto.AlarmStateTransitionPB>
com.inductiveautomation.ignition.common.protocolbuffers.AlarmEnumsProto.AlarmStateTransitionPB
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite
,com.google.protobuf.ProtocolMessageEnum
,Serializable
,Comparable<AlarmEnumsProto.AlarmStateTransitionPB>
,Constable
- Enclosing class:
- AlarmEnumsProto
public static enum AlarmEnumsProto.AlarmStateTransitionPB
extends Enum<AlarmEnumsProto.AlarmStateTransitionPB>
implements com.google.protobuf.ProtocolMessageEnum
com.inductiveautomation.ignition.common.alarming.AlarmStateTransitionProtobuf enum
common.protobuf.AlarmStateTransitionPB
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionTransition_Ack = 2;
Transition_Active = 0;
Transition_Clear = 1;
This transition is used to indicate that an alarm event is no longer "live" due to alarm being force disabled.This transition is used to indicate that the alarm event has become "live" due to alarm being force enabled.This transition is used to indicate that an alarm event is no longer needed and should drop out of the system.This transition is used to indicate when an alarm is first shelved. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Transition_Ack = 2;
static final int
Transition_Active = 0;
static final int
Transition_Clear = 1;
static final int
This transition is used to indicate that an alarm event is no longer "live" due to alarm being force disabled.static final int
This transition is used to indicate that the alarm event has become "live" due to alarm being force enabled.static final int
This transition is used to indicate that an alarm event is no longer needed and should drop out of the system.static final int
This transition is used to indicate when an alarm is first shelved. -
Method Summary
Modifier and TypeMethodDescriptionforNumber
(int value) static final com.google.protobuf.Descriptors.EnumDescriptor
final com.google.protobuf.Descriptors.EnumDescriptor
final int
final com.google.protobuf.Descriptors.EnumValueDescriptor
static com.google.protobuf.Internal.EnumLiteMap<AlarmEnumsProto.AlarmStateTransitionPB>
valueOf
(int value) Deprecated.valueOf
(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this class with the specified name.Returns the enum constant of this class with the specified name.values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
Transition_Active
Transition_Active = 0;
-
Transition_Clear
Transition_Clear = 1;
-
Transition_Ack
Transition_Ack = 2;
-
Transition_Finished
This transition is used to indicate that an alarm event is no longer needed and should drop out of the system.
Transition_Finished = 3;
-
Transition_Enabled
This transition is used to indicate that the alarm event has become "live" due to alarm being force enabled. This will immediately be followed by an active or a clear transition.
Transition_Enabled = 4;
-
Transition_Disabled
This transition is used to indicate that an alarm event is no longer "live" due to alarm being force disabled. This will immediately be followed by a finished transition.
Transition_Disabled = 5;
-
Transition_Shelved
This transition is used to indicate when an alarm is first shelved.
Transition_Shelved = 6;
-
UNRECOGNIZED
-
-
Field Details
-
Transition_Active_VALUE
public static final int Transition_Active_VALUETransition_Active = 0;
- See Also:
-
Transition_Clear_VALUE
public static final int Transition_Clear_VALUETransition_Clear = 1;
- See Also:
-
Transition_Ack_VALUE
public static final int Transition_Ack_VALUETransition_Ack = 2;
- See Also:
-
Transition_Finished_VALUE
public static final int Transition_Finished_VALUEThis transition is used to indicate that an alarm event is no longer needed and should drop out of the system.
Transition_Finished = 3;
- See Also:
-
Transition_Enabled_VALUE
public static final int Transition_Enabled_VALUEThis transition is used to indicate that the alarm event has become "live" due to alarm being force enabled. This will immediately be followed by an active or a clear transition.
Transition_Enabled = 4;
- See Also:
-
Transition_Disabled_VALUE
public static final int Transition_Disabled_VALUEThis transition is used to indicate that an alarm event is no longer "live" due to alarm being force disabled. This will immediately be followed by a finished transition.
Transition_Disabled = 5;
- See Also:
-
Transition_Shelved_VALUE
public static final int Transition_Shelved_VALUEThis transition is used to indicate when an alarm is first shelved.
Transition_Shelved = 6;
- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumber
in interfacecom.google.protobuf.Internal.EnumLite
- Specified by:
getNumber
in interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
value
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
forNumber
- Parameters:
value
- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
public static com.google.protobuf.Internal.EnumLiteMap<AlarmEnumsProto.AlarmStateTransitionPB> internalGetValueMap() -
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptor
in interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static AlarmEnumsProto.AlarmStateTransitionPB valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
desc
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-