Package com.inductiveautomation.sfc.scripting

Class SfcScriptingFunctionsPyWrapper

java.lang.Object

com.inductiveautomation.sfc.scripting.SfcScriptingFunctionsPyWrapper

Direct Known Subclasses:

ClientSfcScriptingFunctionsPyWrapper

public abstract class SfcScriptingFunctionsPyWrapper
extends Object

This is the actual class that is added to the scripting system to implement the SFC functions. It parses friendlier arguments and calls the actual RPC functions in SfcRpcFunctions

Constructor Summary

Constructors

Constructor	Description
SfcScriptingFunctionsPyWrapper(SfcRpcFunctions delegate)

Method Summary

Modifier and Type	Method	Description
void	cancelChart(String instanceId)
Dataset	getRunningCharts()
Dataset	getRunningCharts(String chartPath)
protected abstract String	getUsername()
PyChartScope	getVariables(String instanceId)
void	pauseChart(String instanceId)
void	redundantCheckpoint(String instanceId)
void	resumeChart(String instanceId)
void	setVariable(String instanceId, String variableName, Object variableValue)
void	setVariable(String instanceId, String stepId, String variableName, Object variableValue)
void	setVariables(String instanceId, String stepId, org.python.core.PyObject variablesMap)
void	setVariables(String instanceId, org.python.core.PyObject variablesMap)
String	startChart(String projectName, String chartPath, Map<String,Object> parameters)
String	startChart(String chartPath, Map<String,Object> parameters)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

SfcScriptingFunctionsPyWrapper

public SfcScriptingFunctionsPyWrapper(SfcRpcFunctions delegate)

Method Details

startChart

@Deprecated(forRemoval=false)
public String startChart(String chartPath,
 Map<String,Object> parameters)
                  throws Exception

Deprecated.

Throws:

Exception

startChart

public String startChart(String projectName,
 String chartPath,
 Map<String,Object> parameters)
                  throws Exception

Throws:

Exception

getRunningCharts

public Dataset getRunningCharts()
                         throws Exception

Throws:

Exception

getRunningCharts

public Dataset getRunningCharts(String chartPath)
                         throws Exception

Throws:

Exception

cancelChart

public void cancelChart(String instanceId)
                 throws Exception

Throws:

Exception

pauseChart

public void pauseChart(String instanceId)
                throws Exception

Throws:

Exception

resumeChart

public void resumeChart(String instanceId)
                 throws Exception

Throws:

Exception

getVariables

public PyChartScope getVariables(String instanceId)
                          throws Exception

Throws:

Exception

setVariable

public void setVariable(String instanceId,
 String variableName,
 Object variableValue)

setVariable

public void setVariable(String instanceId,
 String stepId,
 String variableName,
 Object variableValue)

setVariables

public void setVariables(String instanceId,
 org.python.core.PyObject variablesMap)

setVariables

public void setVariables(String instanceId,
 String stepId,
 org.python.core.PyObject variablesMap)

redundantCheckpoint

public void redundantCheckpoint(String instanceId)
                         throws Exception

Throws:

Exception

getUsername

protected abstract String getUsername()