Package com.inductiveautomation.ignition.common.expressions

Enum Class DefaultFunctionFactory.IsQualityFunction

java.lang.Object

java.lang.Enum<DefaultFunctionFactory.IsQualityFunction>

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.IsQualityFunction

All Implemented Interfaces:

Function, Serializable, Comparable<DefaultFunctionFactory.IsQualityFunction>, Constable

Enclosing class:

DefaultFunctionFactory

public static enum DefaultFunctionFactory.IsQualityFunction
extends Enum<DefaultFunctionFactory.IsQualityFunction>
implements Function

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
IsBad
IsBadOrError
IsError
IsUncertain

Method Summary

Modifier and Type	Method	Description
void	connect(CommonContext context, InteractionListener updateListener)	Gives the function a chance to connect itself to things, if necessary.
Function	copy()	Creates a copy of this function.
void	disconnect()	Tells the function to disconnect from anything it was connected to.
QualifiedValue	execute(Expression[] args)	Execute this function, and return the function's qualified value.
String	getArgDocString()	Returns a string to be used in the auto-generated function documentation.
Class<?>	getType()	Returns the type that this function will return upon execution
void	initArgs(Expression[] args)	Initialize this function with the given arguments.
void	shutdown()	Tells the function to shutdown any polling operations.
void	startup()	Tells the function to startup any polling operations.
static DefaultFunctionFactory.IsQualityFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultFunctionFactory.IsQualityFunction[]	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

IsBad

public static final DefaultFunctionFactory.IsQualityFunction IsBad

IsError

public static final DefaultFunctionFactory.IsQualityFunction IsError

IsBadOrError

public static final DefaultFunctionFactory.IsQualityFunction IsBadOrError

IsUncertain

public static final DefaultFunctionFactory.IsQualityFunction IsUncertain

Method Details

values

public static DefaultFunctionFactory.IsQualityFunction[] 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 DefaultFunctionFactory.IsQualityFunction 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

execute

public QualifiedValue execute(Expression[] args)
                       throws ExpressionException

Description copied from interface: Function

Execute this function, and return the function's qualified value.

Specified by:

execute in interface Function

Throws:

ExpressionException

initArgs

public void initArgs(Expression[] args)

Description copied from interface: Function

Initialize this function with the given arguments.

Specified by:

initArgs in interface Function

getArgDocString

public String getArgDocString()

Description copied from interface: Function

Returns a string to be used in the auto-generated function documentation. The string should represent the arguments for the function, such as "string, count" for the "repeat" function.

Specified by:

getArgDocString in interface Function

copy

public Function copy()

Description copied from interface: Function

Creates a copy of this function. Each FunctionExpression will always retrieve a copy of the function that it wants. It is up to the function whether or not a true copy is retrieved, or simply a reference to the main function object. If the function stores transient data during serialization, and thus cannot be shared between expressions, a copy must be made.

Specified by:

copy in interface Function

connect

public void connect(CommonContext context,
 InteractionListener updateListener)

Description copied from interface: Function

Gives the function a chance to connect itself to things, if necessary. Most functions do not have any connections. A function should notify the updateListener if they change. The implementation of InteractionListener should execute as quickly as possible, and should not block.

Specified by:

connect in interface Function

disconnect

public void disconnect()

Description copied from interface: Function

Tells the function to disconnect from anything it was connected to.

Specified by:

disconnect in interface Function

startup

public void startup()

Description copied from interface: Function

Tells the function to startup any polling operations. Functions that use this can remember the updateListener from connect() to feed update notification to.

Specified by:

startup in interface Function

shutdown

public void shutdown()

Description copied from interface: Function

Tells the function to shutdown any polling operations.

Specified by:

shutdown in interface Function

getType

public Class<?> getType()

Description copied from interface: Function

Returns the type that this function will return upon execution

Specified by:

getType in interface Function