Class BaseFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
- All Implemented Interfaces:
Function
- Direct Known Subclasses:
AbstractFunction, DefaultFunctionFactory.CastFunction, DefaultFunctionFactory.CharFunction, DefaultFunctionFactory.ConcatFunction, DefaultFunctionFactory.EscapeSQL, DefaultFunctionFactory.EscapeXML, DefaultFunctionFactory.GradientFunction, DefaultFunctionFactory.IndexOfFunction, DefaultFunctionFactory.OrdinalFunction, DefaultFunctionFactory.PowerFunction, DefaultFunctionFactory.QualityOfFunction, DefaultFunctionFactory.RepeatFunction, DefaultFunctionFactory.RoundFunction, DefaultFunctionFactory.SingleArgMathFunction, DefaultFunctionFactory.SplitStringFunction, DefaultFunctionFactory.StringCaseFunction, DefaultFunctionFactory.StringTrimFunction, DefaultFunctionFactory.SubstringFunction, DefaultFunctionFactory.TimestampOfFunction, DefaultFunctionFactory.TypeOfFunction, DefaultFunctionFactory.UrlEncode, JsonFormat, JsonGet, JsonSet
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidconnect(CommonContext context, InteractionListener updateListener) Empty implementation from BaseFunction.copy()Returns this.voidEmpty implementation from BaseFunction.protected QualifiedValue[]executeAll(Expression[] args) Helper function to execute all sub expressions for simple functions that just use all values.voidshutdown()Empty implementation from BaseFunction.voidstartup()Empty implementation from BaseFunction.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Function
execute, getArgDocString, getDescription, getType, initArgs
-
Constructor Details
-
BaseFunction
public BaseFunction()
-
-
Method Details
-
connect
Empty implementation from BaseFunction. Override if necessary.- Specified by:
connectin interfaceFunction- Parameters:
context- theCommonContextused to look up external resourcesupdateListener- theInteractionListenerto notify when the function value changes
-
disconnect
public void disconnect()Empty implementation from BaseFunction. Override if necessary.- Specified by:
disconnectin interfaceFunction
-
shutdown
-
startup
-
copy
-
executeAll
Helper function to execute all sub expressions for simple functions that just use all values.- Parameters:
args- the sub-expressions to execute- Returns:
- an array of
QualifiedValueresults - Throws:
ExpressionException- if any sub-expression fails to execute
-