Class DefaultFunctionFactory.RoundFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.RoundFunction
- All Implemented Interfaces:
Function
- Enclosing class:
DefaultFunctionFactory
-
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.Class<?> getType()Returns the type that this function will return upon executionvoidinitArgs(Expression[] args) Initialize this function with the given arguments.voidMethods 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
-
RoundFunction
public RoundFunction()
-
-
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
-
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
-
initArgs
Description copied from interface:FunctionInitialize this function with the given arguments.- Parameters:
args- the arguments for the function
-
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
-
setType
-