Package com.inductiveautomation.ignition.client.expressions

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 com.inductiveautomation.ignition.client.model.LocaleListener

LOCAL_CHANGE_EVENT

Constructor Summary

Constructors

Constructor	Description
TranslateFunction(String funcName)

Method Summary

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.
String	getArgDocString()	Returns a string to be used in the auto-generated function documentation.
protected String	getFunctionDisplayName()
Class<?>	getType()	Returns the type that this function will return upon execution
void	localeChanged(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

Methods inherited from class java.lang.Object

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

Constructor Details

TranslateFunction

public TranslateFunction(String funcName)

Method Details

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 interface Function

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

public Class<?> getType()

Description copied from interface: Function

Returns the type that this function will return upon execution

Specified by:

getType in interface Function

getArgDocString

public 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 interface Function

Returns:

the argument documentation string

getFunctionDisplayName

protected String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

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 interface Function

Overrides:

copy in class BaseFunction

Returns:

a copy of this function

connect

public void connect(CommonContext context,
 InteractionListener updateListener)

Description copied from class: BaseFunction

Empty implementation from BaseFunction. Override if necessary.

Specified by:

connect in interface Function

Overrides:

connect in class BaseFunction

Parameters:

context - the CommonContext used to look up external resources

updateListener - the InteractionListener to notify when the function value changes

shutdown

public void shutdown()

Description copied from class: BaseFunction

Empty implementation from BaseFunction. Override if necessary.

Specified by:

shutdown in interface Function

Overrides:

shutdown in class BaseFunction

localeChanged

public void localeChanged(Locale newLocale)

Specified by:

localeChanged in interface LocaleListener