Package com.inductiveautomation.ignition.client.expressions

Class ClientFunctionFactory.IsAlarmActiveFunctionClient

java.lang.Object

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

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

com.inductiveautomation.ignition.common.expressions.functions.AbstractPollingFunction

com.inductiveautomation.ignition.client.expressions.ClientFunctionFactory.IsAlarmActiveFunctionClient

All Implemented Interfaces:

Function, ActionListener, EventListener

Enclosing class:

ClientFunctionFactory

public static class ClientFunctionFactory.IsAlarmActiveFunctionClient
extends AbstractPollingFunction

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractPollingFunction

context, rate, started, task, TIMER, updateListener

Constructor Summary

Constructors

Constructor	Description
IsAlarmActiveFunctionClient()

Method Summary

Modifier and Type	Method	Description
Function	copy()	Returns this.
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.
protected String	getFunctionDisplayName()
Class<?>	getType()	Returns the type that this function will return upon execution
protected boolean	validateNumArgs(int num)

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

actionPerformed, cancelTask, connect, disconnect, setPollRate, shutdown, startTask, startup

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

executeArg, initArgs, log

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

executeAll

Methods inherited from class java.lang.Object

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

Constructor Details

IsAlarmActiveFunctionClient

public IsAlarmActiveFunctionClient()

Method Details

getType

public Class<?> getType()

Description copied from interface: Function

Returns the type that this function will return upon execution

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.

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

copy

public Function copy()

Description copied from class: BaseFunction

Returns this. Override to create a clone if you need a unique function object per Expression.

Specified by:

copy in interface Function

Specified by:

copy in class AbstractPollingFunction

getFunctionDisplayName

protected String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

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