Class DefaultFunctionFactory.SequenceFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.SequenceFunction
- All Implemented Interfaces:
Function
- Enclosing class:
DefaultFunctionFactory
Thi seq() function returns an incrementing sequence starting at zero. Useful for QA to measure
how many times an expression has executed.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()Returns this.execute(Expression[] args) Execute this function, and return the function's qualified value.Returns a string to be used in the auto-generated function documentation.protected StringClass<?> getType()Returns the type that this function will return upon executionprotected booleanvalidateNumArgs(int num) Methods inherited from class AbstractFunction
executeArg, initArgs, logMethods inherited from class BaseFunction
connect, disconnect, executeAll, shutdown, startupMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Function
getDescription
-
Constructor Details
-
SequenceFunction
public SequenceFunction()
-
-
Method Details
-
execute
Description copied from interface:FunctionExecute 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
-
getFunctionDisplayName
- Specified by:
getFunctionDisplayNamein classAbstractFunction
-
getArgDocString
Description copied from interface:FunctionReturns 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
-
getType
-
validateNumArgs
protected boolean validateNumArgs(int num) - Overrides:
validateNumArgsin classAbstractFunction
-
copy
Description copied from class:BaseFunctionReturns this. Override to create a clone if you need a unique function object per Expression.- Specified by:
copyin interfaceFunction- Overrides:
copyin classBaseFunction- Returns:
- a copy of this function
-