Package com.inductiveautomation.perspective.gateway.script

Class SessionScriptFunctionHelper

java.lang.Object

com.inductiveautomation.perspective.gateway.script.ScriptFunctionHelper

com.inductiveautomation.perspective.gateway.script.SessionScriptFunctionHelper

Direct Known Subclasses:

ExtensionFunctionImpl, PropertyChangeScript, ScriptAction, SessionScriptRunner

public abstract class SessionScriptFunctionHelper
extends ScriptFunctionHelper

Field Summary

Fields inherited from class com.inductiveautomation.perspective.gateway.script.ScriptFunctionHelper

signature

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SessionScriptFunctionHelper(String signature, String userCode)

Method Summary

Modifier and Type	Method	Description
protected Optional<org.python.core.PyObject>	execute(ScriptFunction func, org.python.core.PyObject[] arguments, String[] keywords)
protected abstract PerspectiveElement	getComponent()
protected String	getDescription()	Describe the location/context of this script.
protected LoggerEx	getLog()
protected ScriptManager	getScriptManager()
protected com.google.common.collect.ImmutableCollection<SecurityLevelConfig>	getSecurityLevels()
protected void	logWarn(String message, Throwable error)

Methods inherited from class com.inductiveautomation.perspective.gateway.script.ScriptFunctionHelper

getTagReferencePath, invoke, invoke, onScriptLibraryChange, py2qualified

Methods inherited from class java.lang.Object

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

Constructor Details

SessionScriptFunctionHelper

protected SessionScriptFunctionHelper(String signature,
 String userCode)

Parameters:

signature - The signature, which is the method name and arguments like "runMe(arg1, arg2)"

userCode - The user's portion of the runnable code

Method Details

getComponent

protected abstract PerspectiveElement getComponent()

getSecurityLevels

protected com.google.common.collect.ImmutableCollection<SecurityLevelConfig> getSecurityLevels()

Specified by:

getSecurityLevels in class ScriptFunctionHelper

getLog

protected LoggerEx getLog()

Specified by:

getLog in class ScriptFunctionHelper

getScriptManager

protected ScriptManager getScriptManager()

Specified by:

getScriptManager in class ScriptFunctionHelper

getDescription

protected String getDescription()

Description copied from class: ScriptFunctionHelper

Describe the location/context of this script. Used for error messages

Specified by:

getDescription in class ScriptFunctionHelper

logWarn

protected void logWarn(String message,
 Throwable error)

Overrides:

logWarn in class ScriptFunctionHelper

execute

protected Optional<org.python.core.PyObject> execute(ScriptFunction func,
 org.python.core.PyObject[] arguments,
 String[] keywords)

Specified by:

execute in class ScriptFunctionHelper