Package com.inductiveautomation.ignition.common.expressions.legacy

Class VariableFunctions.StoreVariableFunction

java.lang.Object

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

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

com.inductiveautomation.ignition.common.expressions.legacy.VariableFunctions.StoreVariableFunction

All Implemented Interfaces:

Function

Enclosing class:

VariableFunctions

public static class VariableFunctions.StoreVariableFunction
extends AbstractFunction

storeVariable(name, value) stores the variable and returns the stored value.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FUNCTION_NAME

Constructor Summary

Constructors

Constructor	Description
StoreVariableFunction()

Method Summary

Modifier and Type	Method	Description
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	initArgs(Expression[] args)	Calls validateNumArgs() to make sure the number of args is correct
protected boolean	validateNumArgs(int num)

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

executeArg, log

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

Field Details

FUNCTION_NAME

public static final String FUNCTION_NAME

See Also:

• Constant Field Values

Constructor Details

StoreVariableFunction

public StoreVariableFunction()

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.

Throws:

ExpressionException

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.

getType

public Class<?> getType()

Description copied from interface: Function

Returns the type that this function will return upon execution

initArgs

public void initArgs(Expression[] args)

Description copied from class: AbstractFunction

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

Specified by:

initArgs in interface Function

Overrides:

initArgs in class AbstractFunction

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

getFunctionDisplayName

protected String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction