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
AbstractFunction simply implements some code to make the checking of arguments and generating of
type mismatch errors more abstracted.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Optional<QualifiedValue> executeArg(Expression[] args, int index) protected abstract StringvoidinitArgs(Expression[] args) CallsvalidateNumArgs(int)to make sure the number of args is correct.protected LoggerExlog()protected booleanvalidateNumArgs(int num) Methods inherited from class BaseFunction
connect, copy, disconnect, executeAll, shutdown, startupMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Function
execute, getArgDocString, getDescription, getType
-
Constructor Details
-
AbstractFunction
public AbstractFunction()
-
-
Method Details
-
initArgs
CallsvalidateNumArgs(int)to make sure the number of args is correct.- Parameters:
args- the arguments for the function
-
executeArg
protected Optional<QualifiedValue> executeArg(Expression[] args, int index) throws ExpressionException - Throws:
ExpressionException
-
validateNumArgs
protected boolean validateNumArgs(int num) -
getFunctionDisplayName
-
log
-