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

Enum Class DropoutCondition

java.lang.Object

java.lang.Enum<DropoutCondition>

com.inductiveautomation.ignition.alarming.common.pipelines.DropoutCondition

All Implemented Interfaces:

Localized, Serializable, Comparable<DropoutCondition>, Constable

public enum DropoutCondition
extends Enum<DropoutCondition>
implements Localized

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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(Collection<DropoutCondition> conditions, AlarmEvent event)	Returns true if any dropout condition is met for the given alarm event
String	toString()
String	toString(Locale locale)
static DropoutCondition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DropoutCondition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OnAck

public static final DropoutCondition OnAck

OnClear

public static final DropoutCondition OnClear

OnShelve

public static final DropoutCondition OnShelve

Method Details

values

public static DropoutCondition[] 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

public static DropoutCondition valueOf(String name)

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 name

NullPointerException - if the argument is null

toString

public String toString(Locale locale)

Specified by:

toString in interface Localized

toString

public String toString()

Overrides:

toString in class Enum<DropoutCondition>

drop

public boolean drop(AlarmEvent alarmEvent)

drop

public static boolean drop(@Nullable
 Collection<DropoutCondition> conditions,
 AlarmEvent event)

Returns true if any dropout condition is met for the given alarm event