Package com.inductiveautomation.ignition.common.alarming.config

Enum AlarmMode

java.lang.Object

java.lang.Enum<AlarmMode>

com.inductiveautomation.ignition.common.alarming.config.AlarmMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AlarmMode>

public enum AlarmMode
extends java.lang.Enum<AlarmMode>

These are the defined types of alarm conditions.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AboveValue
AnyChange
BadQuality
BelowValue
BetweenValues	Active when the value is inside of the defined range.
Bit
Equality
Inequality
OnCondition	This mode is active whenever the "ActiveCondition" value is true.
OutOfEngRange	Very similar to "OutsideValues", but the setpoints are taken from the tag's eng.
OutsideValues	The opposite of "BetweenValues".

Method Summary

Modifier and Type	Method	Description
java.util.Collection<AlarmProperty<?>>	getProperties()
java.lang.String	toString()
static AlarmMode	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AlarmMode[]	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

Equality

public static final AlarmMode Equality

Inequality

public static final AlarmMode Inequality

AboveValue

public static final AlarmMode AboveValue

BelowValue

public static final AlarmMode BelowValue

BetweenValues

public static final AlarmMode BetweenValues

Active when the value is inside of the defined range.

OutsideValues

public static final AlarmMode OutsideValues

The opposite of "BetweenValues". Active when the value is outside the given range.

OutOfEngRange

public static final AlarmMode OutOfEngRange

Very similar to "OutsideValues", but the setpoints are taken from the tag's eng. limits.

BadQuality

public static final AlarmMode BadQuality

AnyChange

public static final AlarmMode AnyChange

Bit

public static final AlarmMode Bit

OnCondition

public static final AlarmMode OnCondition

This mode is active whenever the "ActiveCondition" value is true. Since the condition can be an expression, this allows the user to define their own logic. The important point is that this condition does not depend on the value passed to the condition.

Method Detail

values

public static AlarmMode[] 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 (AlarmMode c : AlarmMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static AlarmMode 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

getProperties

public java.util.Collection<AlarmProperty<?>> getProperties()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<AlarmMode>