Package com.inductiveautomation.ignition.common.expressions

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 Details

    • TimePartBetweenFunction

      public TimePartBetweenFunction()

  • Method Details

    • getType

      public 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 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