Class DefaultFunctionFactory.TimePartBetweenFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.TimePartBetweenFunction
- All Implemented Interfaces:
Function
- Direct Known Subclasses:
DefaultFunctionFactory.DaysBetweenFunction, DefaultFunctionFactory.HoursBetweenFunction, DefaultFunctionFactory.MillisBetweenFunction, DefaultFunctionFactory.MinutesBetweenFunction, DefaultFunctionFactory.MonthsBetweenFunction, DefaultFunctionFactory.SecondsBetweenFunction, DefaultFunctionFactory.WeeksBetweenFunction, DefaultFunctionFactory.YearsBetweenFunction
- Enclosing class:
DefaultFunctionFactory
public abstract static class DefaultFunctionFactory.TimePartBetweenFunction
extends AbstractFunction
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexecute(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 executionprotected booleanvalidateNumArgs(int num) Methods inherited from class AbstractFunction
executeArg, getFunctionDisplayName, initArgs, logMethods inherited from class BaseFunction
connect, copy, 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
-
TimePartBetweenFunction
public TimePartBetweenFunction()
-
-
Method Details
-
getType
-
validateNumArgs
protected boolean validateNumArgs(int num) - Overrides:
validateNumArgsin 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
-
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
-