Package com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.DataSetAggregateFunction

java.lang.Object

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

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

com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.DataSetAggregateFunction

All Implemented Interfaces:

Function

Enclosing class:

DefaultFunctionFactory

public static class DefaultFunctionFactory.DataSetAggregateFunction
extends AbstractFunction

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.util.Map<java.lang.String,com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.DataSetAggregateFunction.AggregateCalculation>	calculations
protected java.lang.String	funcName

Constructor Summary

Constructors

Constructor	Description
DataSetAggregateFunction()
DataSetAggregateFunction(java.lang.String name)

Method Summary

Modifier and Type	Method	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.
java.lang.String	getFuncName()
protected java.lang.String	getFunctionDisplayName()
java.lang.Class<?>	getType()	Returns the type that this function will return upon execution
void	setFuncName(java.lang.String funcName)
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

connect, copy, disconnect, executeAll, shutdown, startup

Methods inherited from class java.lang.Object

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

Field Detail

funcName

protected java.lang.String funcName

calculations

protected static java.util.Map<java.lang.String,com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.DataSetAggregateFunction.AggregateCalculation> calculations

Constructor Detail

DataSetAggregateFunction

public DataSetAggregateFunction()

DataSetAggregateFunction

public DataSetAggregateFunction(java.lang.String name)

Method Detail

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.

getFunctionDisplayName

protected java.lang.String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs 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

getType

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

Description copied from interface: Function

Returns the type that this function will return upon execution

getFuncName

public java.lang.String getFuncName()

setFuncName

public void setFuncName(java.lang.String funcName)