Package com.inductiveautomation.perspective.gateway.expression

Class PropertyFunction

java.lang.Object

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

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

com.inductiveautomation.perspective.gateway.expression.PropertyFunction

All Implemented Interfaces:

Function

public class PropertyFunction
extends AbstractFunction

Method Summary

Modifier and Type	Method	Description
void	connect(CommonContext context, InteractionListener updateListener)	Empty implementation from BaseFunction.
void	disconnect()	Empty implementation from BaseFunction.
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()
void	shutdown()	Empty implementation from BaseFunction.
protected boolean	validateNumArgs(int num)

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

copy, executeAll, startup

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.expressions.functions.Function

getType

Method Details

connect

public void connect(CommonContext context,
 InteractionListener updateListener)

Description copied from class: BaseFunction

Empty implementation from BaseFunction. Override if necessary.

Specified by:

connect in interface Function

Overrides:

connect in class BaseFunction

Parameters:

context - the CommonContext used to look up external resources

updateListener - the InteractionListener to notify when the function value changes

execute

public QualifiedValue execute(Expression[] args)
                       throws ExpressionException

Description copied from interface: Function

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

Parameters:

args - the arguments for the function

Returns:

the result of the function evaluation as a QualifiedValue

Throws:

ExpressionException - if an error occurs during execution

disconnect

public void disconnect()

Description copied from class: BaseFunction

Empty implementation from BaseFunction. Override if necessary.

Specified by:

disconnect in interface Function

Overrides:

disconnect in class BaseFunction

shutdown

public void shutdown()

Description copied from class: BaseFunction

Empty implementation from BaseFunction. Override if necessary.

Specified by:

shutdown in interface Function

Overrides:

shutdown in class BaseFunction

getFunctionDisplayName

protected String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

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.

Returns:

the argument documentation string