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

Class AbstractFunction

java.lang.Object

com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

AbstractPollingFunction, AlarmBasedFunctionFactory.AlarmStateFunction, ClientFunctionFactory.HasRoleFunctionClient, ClientFunctionFactory.TranslateFunction, DBFunctions.DBFunction, DefaultFunctionFactory.AddTimeFunction, DefaultFunctionFactory.AggregateConcatFunction, DefaultFunctionFactory.BinaryEncFunction, DefaultFunctionFactory.BinaryEnumFunction, DefaultFunctionFactory.CoalesceFunction, DefaultFunctionFactory.ColorChanger, DefaultFunctionFactory.ColumnRearrangeFunction, DefaultFunctionFactory.ColumnRenameFunction, DefaultFunctionFactory.CreateColorFunction, DefaultFunctionFactory.DataSetAggregateFunction, DefaultFunctionFactory.DataSetDateAggregateFunction, DefaultFunctionFactory.DateArithmeticFunction, DefaultFunctionFactory.DateDiffFunction, DefaultFunctionFactory.DateExtractFunction, DefaultFunctionFactory.DateFormatFunction, DefaultFunctionFactory.DateIsAfterFunction, DefaultFunctionFactory.DateIsBeforeFunction, DefaultFunctionFactory.DateIsBetweenFunction, DefaultFunctionFactory.DateIsDaylightTimeFunction, DefaultFunctionFactory.ForceQualityFunction, DefaultFunctionFactory.FromBinaryFunction, DefaultFunctionFactory.FromHexFunction, DefaultFunctionFactory.FromMillisFunction, DefaultFunctionFactory.FromOctalFunction, DefaultFunctionFactory.GetBitFunction, DefaultFunctionFactory.GetDateFunction, DefaultFunctionFactory.GetDatePartFunction, DefaultFunctionFactory.GetTimezoneFunction, DefaultFunctionFactory.GetTimezoneRawOffsetFunction, DefaultFunctionFactory.IfFunction, DefaultFunctionFactory.IsGoodFunction, DefaultFunctionFactory.IsNullFunction, DefaultFunctionFactory.LeftOrRightFunction, DefaultFunctionFactory.LengthFunction, DefaultFunctionFactory.LookupFunction, DefaultFunctionFactory.MidnightFunction, DefaultFunctionFactory.NumberFormatFunction, DefaultFunctionFactory.QualifiedValueFunction, DefaultFunctionFactory.ReplaceFunction, DefaultFunctionFactory.SequenceFunction, DefaultFunctionFactory.SetTimeFunction, DefaultFunctionFactory.SortDatasetFunction, DefaultFunctionFactory.StringFormatFunction, DefaultFunctionFactory.SwitchFunction, DefaultFunctionFactory.TimeBetweenFunction, DefaultFunctionFactory.TimePartBetweenFunction, DefaultFunctionFactory.ToBinaryFunction, DefaultFunctionFactory.ToHexFunction, DefaultFunctionFactory.ToMillisFunction, DefaultFunctionFactory.ToOctalFunction, DefaultFunctionFactory.TryFunction, com.inductiveautomation.ignition.gateway.expressions.GatewayFunctionFactory.TranslateFunction, PropertyBasedFunctionFactory.GetPropertyFunction, PropertyBasedFunctionFactory.IsDefinedFunction, PropertyFunction, TagFunction, TagFunctionFactory.DatacacheCountFunction, TagFunctionFactory.FSQLDateExtractFunction, VariableFunctions.ClearVariablesFunction, VariableFunctions.DeleteVariableFunction, VariableFunctions.GetVariableFunction, VariableFunctions.IsVariableDefinedFunction, VariableFunctions.StoreVariableFunction

public abstract class AbstractFunction
extends BaseFunction

AbstractFunction simply implements some code to make the checking of arguments and generating of type mismatch errors more abstracted.

Constructor Summary

Constructors

Constructor	Description
AbstractFunction()

Method Summary

Modifier and Type	Method	Description
protected Optional<QualifiedValue>	executeArg(Expression[] args, int index)
protected abstract String	getFunctionDisplayName()
void	initArgs(Expression[] args)	Calls validateNumArgs() to make sure the number of args is correct
protected LoggerEx	log()
protected boolean	validateNumArgs(int num)

Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction

connect, copy, disconnect, executeAll, shutdown, startup

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

Constructor Details

AbstractFunction

public AbstractFunction()

Method Details

initArgs

public void initArgs(Expression[] args)

Calls validateNumArgs() to make sure the number of args is correct

executeArg

protected Optional<QualifiedValue> executeArg(Expression[] args,
 int index)
                                       throws ExpressionException

Throws:

ExpressionException

validateNumArgs

protected boolean validateNumArgs(int num)

getFunctionDisplayName

protected abstract String getFunctionDisplayName()

log

protected LoggerEx log()