Package com.inductiveautomation.ignition.alarming.common.pipelines

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
OnAck
OnClear
OnShelve

Method Summary

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 event
java.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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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 name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString(java.util.Locale locale)

Specified by:

toString in interface Localized

toString

public java.lang.String toString()

Overrides:

toString in class java.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