Package com.inductiveautomation.ignition.common.expressions.functions

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

public abstract class BaseFunction
extends Object
implements Function

The base class of all functions, includes blank implementations of some of the methods from Function that aren't used by many functions, like the connect/startup stuff. Returns this from copy()

Constructor Summary

Constructors

Constructor	Description
BaseFunction()

Method Summary

Modifier and Type	Method	Description
void	connect(CommonContext context, InteractionListener updateListener)	Empty implementation from BaseFunction.
Function	copy()	Returns this.
void	disconnect()	Empty implementation from BaseFunction.
protected QualifiedValue[]	executeAll(Expression[] args)	Helper function to execute all sub expressions for simple functions that just use all values.
void	shutdown()	Empty implementation from BaseFunction.
void	startup()	Empty implementation from BaseFunction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.common.expressions.functions.Function

execute, getArgDocString, getType, initArgs

Constructor Details

BaseFunction

public BaseFunction()

Method Details

connect

public void connect(CommonContext context,
 InteractionListener updateListener)

Empty implementation from BaseFunction. Override if necessary.

Specified by:

connect in interface Function

disconnect

public void disconnect()

Empty implementation from BaseFunction. Override if necessary.

Specified by:

disconnect in interface Function

shutdown

public void shutdown()

Empty implementation from BaseFunction. Override if necessary.

Specified by:

shutdown in interface Function

startup

public void startup()

Empty implementation from BaseFunction. Override if necessary.

Specified by:

startup in interface Function

copy

public Function copy()

Returns this. Override to create a clone if you need a unique function object per Expression.

Specified by:

copy in interface Function

executeAll

protected QualifiedValue[] executeAll(Expression[] args)
                               throws ExpressionException

Helper function to execute all sub expressions for simple functions that just use all values.

Throws:

ExpressionException