Class ClientFunctionFactory.TranslateFunction
java.lang.Object
com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
com.inductiveautomation.ignition.client.expressions.ClientFunctionFactory.TranslateFunction
- All Implemented Interfaces:
LocaleListener, Function
- Enclosing class:
ClientFunctionFactory
public static class ClientFunctionFactory.TranslateFunction
extends AbstractFunction
implements LocaleListener
-
Field Summary
Fields inherited from interface LocaleListener
LOCAL_CHANGE_EVENT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidconnect(CommonContext context, InteractionListener updateListener) Empty implementation from BaseFunction.copy()Returns this.execute(Expression[] args) Execute this function, and return the function's qualified value.Returns a string to be used in the auto-generated function documentation.protected StringClass<?> getType()Returns the type that this function will return upon executionvoidlocaleChanged(Locale newLocale) voidshutdown()Empty implementation from BaseFunction.Methods inherited from class AbstractFunction
executeArg, initArgs, log, validateNumArgsMethods inherited from class BaseFunction
disconnect, executeAll, startupMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface Function
getDescription
-
Constructor Details
-
TranslateFunction
-
-
Method Details
-
execute
Description copied from interface:FunctionExecute this function, and return the function's qualified value.- Specified by:
executein interfaceFunction- Parameters:
args- the arguments for the function- Returns:
- the result of the function evaluation as a
QualifiedValue - Throws:
ExpressionException- if an error occurs during execution
-
getType
-
getArgDocString
Description copied from interface:FunctionReturns a string to be used in the auto-generated function documentation. The string should represent the arguments for the function, such as "string, count" for the "repeat" function.- Specified by:
getArgDocStringin interfaceFunction- Returns:
- the argument documentation string
-
getFunctionDisplayName
- Specified by:
getFunctionDisplayNamein classAbstractFunction
-
copy
Description copied from class:BaseFunctionReturns this. Override to create a clone if you need a unique function object per Expression.- Specified by:
copyin interfaceFunction- Overrides:
copyin classBaseFunction- Returns:
- a copy of this function
-
connect
Description copied from class:BaseFunctionEmpty implementation from BaseFunction. Override if necessary.- Specified by:
connectin interfaceFunction- Overrides:
connectin classBaseFunction- Parameters:
context- theCommonContextused to look up external resourcesupdateListener- theInteractionListenerto notify when the function value changes
-
shutdown
public void shutdown()Description copied from class:BaseFunctionEmpty implementation from BaseFunction. Override if necessary.- Specified by:
shutdownin interfaceFunction- Overrides:
shutdownin classBaseFunction
-
localeChanged
- Specified by:
localeChangedin interfaceLocaleListener
-