Package com.inductiveautomation.ignition.common.expressions

Class DefaultFunctionFactory.SwitchFunction

java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
com.inductiveautomation.ignition.common.expressions.DefaultFunctionFactory.SwitchFunction
All Implemented Interfaces:
Function
Direct Known Subclasses:
DefaultFunctionFactory.CaseFunction
Enclosing class:
DefaultFunctionFactory
public static class DefaultFunctionFactory.SwitchFunction extends AbstractFunction

  • Constructor Details

    • SwitchFunction

      public SwitchFunction()

  • Method Details

    • getFunctionDisplayName

      protected String getFunctionDisplayName()
      Specified by:
      getFunctionDisplayName in class AbstractFunction

    • copy

      public Function copy()
      Description copied from class: BaseFunction
      Returns this. Override to create a clone if you need a unique function object per Expression.
      Specified by:
      copy in interface Function
      Overrides:
      copy in class BaseFunction
      Returns:
      a copy of this function

    • validateNumArgs

      protected boolean validateNumArgs(int num)
      Overrides:
      validateNumArgs in class AbstractFunction

    • execute

      public QualifiedValue execute(Expression[] args) throws ExpressionException
      Description copied from interface: Function
      Execute 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

    • 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.
      Returns:
      the argument documentation string

    • getType

      public Class<?> getType()
      Description copied from interface: Function
      Returns the type that this function will return upon execution

    • setType

      public void setType(Class<?> class1)

    • getCaseType

      public Class<?> getCaseType()

    • setCaseType

      public void setCaseType(Class<?> class1)