Package com.inductiveautomation.ignition.common.expressions

Interface FunctionFactory

All Known Subinterfaces:
ExpressionFunctionManager
All Known Implementing Classes:
AbstractFunctionFactory, AlarmBasedFunctionFactory, BasicFunctionFactory, ClientFunctionFactory, ClientFunctionFactory.DynamicDispatchCreatorManager, ContextDelegateFunctionFactory, DefaultFunctionFactory, FSQLFunctionFactory, PropertyBasedFunctionFactory, TagFunctionFactory
public interface FunctionFactory
A factory for looking up and managing expression functions.

  • Method Details

    • getFunction

      Function getFunction(String name)
      Look up the function with the given name. This function will be in a state that is ready to use in an expression, meaning that it may be a cloned copy for functions that keep state.
      Parameters:
      name - the name of the function to look up
      Returns:
      the Function, or null if no function with the given name exists

    • getFunctionNames

      Set<String> getFunctionNames()
      Returns a set of all the registered function names. Used for syntax highlighting in the designer.
      Returns:
      a Set of all registered function names

    • getCategories

      Set<String> getCategories()
      Return a sequence of categories to organize functions. Used to generate the popup menu in the designer. Will automatically organize into submenus based on forward-slash in path.
      Returns:
      a Set of function categories

    • getFunctionsInCategory

      Set<String> getFunctionsInCategory(String name)
      Returns a set of function names that belong to the given category.
      Parameters:
      name - the category name
      Returns:
      a Set of function names in the given category