Package com.inductiveautomation.ignition.common.expressions.functions

Enum Class TagFunction.EvaluationMode

java.lang.Object

java.lang.Enum<TagFunction.EvaluationMode>

com.inductiveautomation.ignition.common.expressions.functions.TagFunction.EvaluationMode

All Implemented Interfaces:

Serializable, Comparable<TagFunction.EvaluationMode>, Constable

Enclosing class:

TagFunction

public static enum TagFunction.EvaluationMode
extends Enum<TagFunction.EvaluationMode>

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
Read	Reads on each execute
Subscribed	Pure subscription, values come in when they do
Subscribed_ReadInitial	Subscribed for update events, but reads the initial value when the path changes.

Method Summary

Modifier and Type	Method	Description
boolean	isSubscribed()
static TagFunction.EvaluationMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TagFunction.EvaluationMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Subscribed

public static final TagFunction.EvaluationMode Subscribed

Pure subscription, values come in when they do

Subscribed_ReadInitial

public static final TagFunction.EvaluationMode Subscribed_ReadInitial

Subscribed for update events, but reads the initial value when the path changes.

Read

public static final TagFunction.EvaluationMode Read

Reads on each execute

Method Details

values

public static TagFunction.EvaluationMode[] 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 TagFunction.EvaluationMode 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

isSubscribed

public boolean isSubscribed()