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
Constructor Description

TimePartBetweenFunction()

Method Summary

All Methods Instance Methods Concrete Methods
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.Class<?>`	`getType()`	Returns the type that this function will return upon execution
`protected boolean`	`validateNumArgs(int num)`

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
executeArg, getFunctionDisplayName, 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

- Constructor Detail
  - TimePartBetweenFunction
```
public TimePartBetweenFunction()
```
- Method Detail
  - getType
```
public java.lang.Class<?> getType()
```
    Description copied from interface: Function
    
    Returns the type that this function will return upon execution
  - validateNumArgs
```
protected boolean validateNumArgs(int num)
```
    Overrides:
    
    validateNumArgs in class AbstractFunction
  - 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.
  - 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