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
-
-
Constructor Summary
Constructors Constructor Description TranslateFunction(java.lang.String funcName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
connect(CommonContext context, InteractionListener updateListener)
Empty implementation from BaseFunction.Function
copy()
Returns this.QualifiedValue
execute(Expression[] args)
Execute this function, and return the function's qualified value.java.lang.String
getArgDocString()
Returns a string to be used in the auto-generated function documentation.protected java.lang.String
getFunctionDisplayName()
java.lang.Class<?>
getType()
Returns the type that this function will return upon executionvoid
localeChanged(java.util.Locale newLocale)
void
shutdown()
Empty implementation from BaseFunction.-
Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractFunction
executeArg, initArgs, log, validateNumArgs
-
Methods inherited from class com.inductiveautomation.ignition.common.expressions.functions.BaseFunction
disconnect, executeAll, startup
-
-
-
-
Method Detail
-
execute
public QualifiedValue execute(Expression[] args) throws ExpressionException
Description copied from interface:Function
Execute this function, and return the function's qualified value.- Specified by:
execute
in interfaceFunction
- Throws:
ExpressionException
-
getType
public java.lang.Class<?> getType()
Description copied from interface:Function
Returns the type that this function will return upon execution
-
getArgDocString
public java.lang.String getArgDocString()
Description copied from interface:Function
Returns 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:
getArgDocString
in interfaceFunction
-
getFunctionDisplayName
protected java.lang.String getFunctionDisplayName()
- Specified by:
getFunctionDisplayName
in classAbstractFunction
-
copy
public Function copy()
Description copied from class:BaseFunction
Returns this. Override to create a clone if you need a unique function object per Expression.- Specified by:
copy
in interfaceFunction
- Overrides:
copy
in classBaseFunction
-
connect
public void connect(CommonContext context, InteractionListener updateListener)
Description copied from class:BaseFunction
Empty implementation from BaseFunction. Override if necessary.- Specified by:
connect
in interfaceFunction
- Overrides:
connect
in classBaseFunction
-
shutdown
public void shutdown()
Description copied from class:BaseFunction
Empty implementation from BaseFunction. Override if necessary.- Specified by:
shutdown
in interfaceFunction
- Overrides:
shutdown
in classBaseFunction
-
localeChanged
public void localeChanged(java.util.Locale newLocale)
- Specified by:
localeChanged
in interfaceLocaleListener
-
-