com.inductiveautomation.ignition.common.expressions.legacy

Class VariableFunctions.ClearVariablesFunction

java.lang.Object

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

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

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

All Implemented Interfaces:

Function

Enclosing class:

VariableFunctions

public static class VariableFunctions.ClearVariablesFunction
extends AbstractFunction

clearVariables() clears all of the stored variables and returns the number of variables cleared.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FUNCTION_NAME

Constructor Summary

Constructors

Constructor and Description
ClearVariablesFunction()

Method Summary

Modifier and Type	Method and Description
TagValue	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 of Object that this function will generate with execute
protected boolean	validateNumArgs(int num)

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

initArgs, validateArgType

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 Detail

FUNCTION_NAME

public static final java.lang.String FUNCTION_NAME

See Also:

Constant Field Values

Constructor Detail

ClearVariablesFunction

public ClearVariablesFunction()

Method Detail

execute

public TagValue execute(Expression[] args)
                 throws ExpressionException

Description copied from interface: Function

Execute this function, and return the function's qualified value.

Returns:

Throws:

ExpressionException

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.

Returns:

getType

public java.lang.Class<?> getType()

Description copied from interface: Function

Returns the type of Object that this function will generate with execute

Returns:

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

getFunctionDisplayName

protected java.lang.String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction