com.inductiveautomation.ignition.common.alarming

Class AlarmBasedFunctionFactory.AlarmStateFunction

java.lang.Object

com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

com.inductiveautomation.ignition.common.alarming.AlarmBasedFunctionFactory.AlarmStateFunction

All Implemented Interfaces:

Function

Enclosing class:

AlarmBasedFunctionFactory

protected class AlarmBasedFunctionFactory.AlarmStateFunction
extends AbstractFunction

Constructor Summary

Constructors

Constructor and Description
AlarmStateFunction(AlarmStateTransition state)

Method Summary

Modifier and Type	Method and Description
QualifiedValue	execute(Expression[] args) Execute this function, and return the function's qualified value.
java.lang.String	getArgDocString() Returns a string to be used in the auto-generated function documentation.
protected java.lang.String	getFunctionDisplayName()
java.lang.Class<?>	getType() Returns the type of Object that this function will generate with execute

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

initArgs, log, validateArgType, validateNumArgs

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

connect, copy, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlarmStateFunction

public AlarmStateFunction(AlarmStateTransition state)

Method Detail

execute

public QualifiedValue execute(Expression[] args)
                       throws ExpressionException

Description copied from interface: Function

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

Throws:

ExpressionException

getFunctionDisplayName

protected java.lang.String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

getType

public java.lang.Class<?> getType()

Description copied from interface: Function

Returns the type of Object that this function will generate with execute

getArgDocString

public java.lang.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.