Package com.inductiveautomation.ignition.common.expressions

Class FunctionExpression

java.lang.Object

com.inductiveautomation.ignition.common.expressions.AbstractExpression

com.inductiveautomation.ignition.common.expressions.FunctionExpression

All Implemented Interfaces:

Expression

public class FunctionExpression
extends AbstractExpression

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.expressions.AbstractExpression

children, context, updateListener

Constructor Summary

Constructors

Constructor	Description
FunctionExpression()
FunctionExpression(ExpressionParseContext context, String funcName, List<Expression> argList)

Method Summary

Modifier and Type	Method	Description
void	connect(CommonContext context, InteractionListener updateListener)	Gives the expression a chance to connect itself to things, if necessary.
void	disconnect()	Tells the expression to disconnect from anything it was connected to.
@NonNull QualifiedValue	execute()	Compute and return the value of this expression.
Function	getFunc()
String	getFuncName()
String	getOpName()	Return a human-readable name for the operation that this expression performs.
Class<?>	getType()	Return the type that this expression will return.
void	setFunc(Function function)
void	setFuncName(String string)
void	shutdown()	Tells the expression to shutdown any polling operations.
void	startup()	Tells the expression to startup any polling operations.

Methods inherited from class com.inductiveautomation.ignition.common.expressions.AbstractExpression

getChildren, setChildren

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionExpression

public FunctionExpression(ExpressionParseContext context,
 String funcName,
 List<Expression> argList)

FunctionExpression

public FunctionExpression()

Method Details

connect

public void connect(CommonContext context,
 InteractionListener updateListener)

Description copied from interface: Expression

Gives the expression a chance to connect itself to things, if necessary. Most expressions do not have any connections. An expression should notify the updateListener if they change.

Specified by:

connect in interface Expression

Overrides:

connect in class AbstractExpression

Parameters:

context - the CommonContext used to look up external resources

updateListener - the InteractionListener to notify when the expression value changes

disconnect

public void disconnect()

Description copied from interface: Expression

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

Specified by:

disconnect in interface Expression

Overrides:

disconnect in class AbstractExpression

shutdown

public void shutdown()

Description copied from interface: Expression

Tells the expression to shutdown any polling operations.

Specified by:

shutdown in interface Expression

Overrides:

shutdown in class AbstractExpression

startup

public void startup()

Description copied from interface: Expression

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

Specified by:

startup in interface Expression

Overrides:

startup in class AbstractExpression

execute

public @NonNull QualifiedValue execute()
                                throws ExpressionException

Description copied from interface: Expression

Compute and return the value of this expression.

Returns:

the result of the expression evaluation as a QualifiedValue

Throws:

ExpressionException - if an error occurs during execution

getType

public Class<?> getType()

Description copied from interface: Expression

Return the type that this expression will return.

Returns:

the Class of the value returned by Expression.execute()

getOpName

public String getOpName()

Description copied from interface: Expression

Return a human-readable name for the operation that this expression performs.

Returns:

the operation name

getFunc

public Function getFunc()

getFuncName

public String getFuncName()

setFunc

public void setFunc(Function function)

setFuncName

public void setFuncName(String string)