com.inductiveautomation.ignition.common.expressions.functions

Class ScriptFunction

java.lang.Object

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

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

com.inductiveautomation.ignition.common.expressions.functions.AbstractPollingFunction

com.inductiveautomation.ignition.common.expressions.functions.ScriptFunction

All Implemented Interfaces:

Function, java.awt.event.ActionListener, java.util.EventListener

Direct Known Subclasses:

ComponentRunScriptExpression

public class ScriptFunction
extends AbstractPollingFunction

Field Summary

Fields

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

Fields inherited from class com.inductiveautomation.ignition.common.expressions.functions.AbstractPollingFunction

context, rate, started, task, timer, updateListener

Constructor Summary

Constructors

Constructor and Description
ScriptFunction()

Method Summary

Modifier and Type	Method and Description
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 of Object that this function will generate with execute
protected void	initLocalsMap(org.python.core.PyStringMap map)
protected boolean	validateArgType(int argNum, java.lang.Class<?> type)
protected boolean	validateNumArgs(int num)

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

actionPerformed, cancelTask, connect, disconnect, setPollRate, shutdown, startTask, startup

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

initArgs

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

executeAll

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

ScriptFunction

public ScriptFunction()

Method Detail

getFunctionDisplayName

protected java.lang.String getFunctionDisplayName()

Specified by:

getFunctionDisplayName in class AbstractFunction

execute

public QualifiedValue execute(Expression[] args)
                       throws ExpressionException

Description copied from interface: Function

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

Returns:

Throws:

ExpressionException

initLocalsMap

protected void initLocalsMap(org.python.core.PyStringMap map)

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

Specified by:

copy in class AbstractPollingFunction

Returns:

validateArgType

protected boolean validateArgType(int argNum,
                                  java.lang.Class<?> type)

Overrides:

validateArgType in class AbstractFunction

validateNumArgs

protected boolean validateNumArgs(int num)

Overrides:

validateNumArgs in class AbstractFunction

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: