Package com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.PowerFunction

java.lang.Object

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

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.PowerFunction

All Implemented Interfaces:

Function

Enclosing class:

DefaultFunctionFactory

public static class DefaultFunctionFactory.PowerFunction
extends BaseFunction

Constructor Summary

Constructors

Constructor	Description
PowerFunction()

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.
Class<?>	getType()	Returns the type that this function will return upon execution
void	initArgs(Expression[] args)	Initialize this function with the given arguments.

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

connect, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object

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

Constructor Details

PowerFunction

public PowerFunction()

Method Details

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

initArgs

public void initArgs(Expression[] args)

Description copied from interface: Function

Initialize this function with the given arguments.

Parameters:

args - the arguments for the function

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

Overrides:

copy in class BaseFunction

Returns:

a copy of this function

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.

Returns:

the argument documentation string