Enum DropoutCondition
- java.lang.Object
-
- java.lang.Enum<DropoutCondition>
-
- com.inductiveautomation.ignition.alarming.common.pipelines.DropoutCondition
-
- All Implemented Interfaces:
Localized
,java.io.Serializable
,java.lang.Comparable<DropoutCondition>
public enum DropoutCondition extends java.lang.Enum<DropoutCondition> implements Localized
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
drop(AlarmEvent alarmEvent)
static boolean
drop(java.util.Collection<DropoutCondition> conditions, AlarmEvent event)
Returns true if any dropout condition is met for the given alarm eventjava.lang.String
toString()
java.lang.String
toString(java.util.Locale locale)
static DropoutCondition
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static DropoutCondition[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
OnAck
public static final DropoutCondition OnAck
-
OnClear
public static final DropoutCondition OnClear
-
OnShelve
public static final DropoutCondition OnShelve
-
-
Method Detail
-
values
public static DropoutCondition[] 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 (DropoutCondition c : DropoutCondition.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DropoutCondition valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
toString
public java.lang.String toString(java.util.Locale locale)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<DropoutCondition>
-
drop
public boolean drop(AlarmEvent alarmEvent)
-
drop
public static boolean drop(@Nullable java.util.Collection<DropoutCondition> conditions, AlarmEvent event)
Returns true if any dropout condition is met for the given alarm event
-
-