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

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getCategories()
Function	getFunction(java.lang.String name) Look up the function with the given name.
java.util.Set<java.lang.String>	getFunctionNames() Returns a set of all the registered function names.
java.util.Set<java.lang.String>	getFunctionsInCategory(java.lang.String name)

Method Detail

getFunction

Function getFunction(java.lang.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.

Returns:

The function, or null

getFunctionNames

java.util.Set<java.lang.String> getFunctionNames()

Returns a set of all the registered function names. Used for syntax highlighting in the designer.

getCategories

java.util.Set<java.lang.String> getCategories()

getFunctionsInCategory

java.util.Set<java.lang.String> getFunctionsInCategory(java.lang.String name)