com.inductiveautomation.ignition.common.sqltags.scripts

Class AbstractTagScript

java.lang.Object

com.inductiveautomation.ignition.common.sqltags.scripts.AbstractTagScript

All Implemented Interfaces:

CompiledTagScript

Direct Known Subclasses:

AlarmEventScript, ValueChangeTagScript

public abstract class AbstractTagScript
extends java.lang.Object
implements CompiledTagScript

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTagScript(FunctionInvoker method)

Method Summary

Modifier and Type	Method and Description
protected abstract org.python.core.PyObject[]	buildArgumentsFor(Tag source, TagPath sourcePath, java.lang.Object[] parameters, boolean overflow) Should return an array of pyobjects that will be used as arguments to the function.
void	invoke(Tag source, TagPath sourcePath, java.lang.Object[] parameters, boolean overflow) Executes the script for the given source tags.
boolean	isErrored()
void	setErrored(boolean errored)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.sqltags.scripts.CompiledTagScript

getId

Constructor Detail

AbstractTagScript

protected AbstractTagScript(FunctionInvoker method)

Method Detail

isErrored

public boolean isErrored()

Specified by:

isErrored in interface CompiledTagScript

setErrored

public void setErrored(boolean errored)

Specified by:

setErrored in interface CompiledTagScript

buildArgumentsFor

protected abstract org.python.core.PyObject[] buildArgumentsFor(Tag source,
                                                                TagPath sourcePath,
                                                                java.lang.Object[] parameters,
                                                                boolean overflow)

Should return an array of pyobjects that will be used as arguments to the function.

invoke

public void invoke(Tag source,
                   TagPath sourcePath,
                   java.lang.Object[] parameters,
                   boolean overflow)
            throws java.lang.Exception

Description copied from interface: CompiledTagScript

Executes the script for the given source tags. The parameters passed in are dependent on the type of event being processed. The overflow parameter indicates that other events could not be processed and were dropped before this one.

Specified by:

invoke in interface CompiledTagScript

parameters - understood in the context of the event that is fired.

Throws:

java.lang.Exception