public class ClientScriptingFunctions extends java.lang.Object implements SfcScriptingFunctions
Constructor and Description |
---|
ClientScriptingFunctions() |
Modifier and Type | Method and Description |
---|---|
void |
cancelChart(java.util.UUID instanceId)
Cancels the chart instance indicated by
instanceId . |
void |
debugResume(java.util.UUID instanceId)
Sends a message to the chart instance stopped at a breakpoint to resume normal operations.
|
void |
debugStep(java.util.UUID instanceId)
Sends a message to the chart instance stopped at a breakpoint to step to the next step.
|
java.util.List<ChartInfo> |
getRunningCharts()
Returns information about the currently running charts.
|
java.util.List<ChartInfo> |
getRunningCharts(java.lang.String chartPath)
Returns information about the currently running instances of a given chart path.
|
PyChartScope |
getVariables(java.util.UUID instanceId)
Returns the chart scope for the specified instance.
|
void |
pauseChart(java.util.UUID instanceId)
Pause the chart instance indicated by
instanceId . |
void |
resumeChart(java.util.UUID instanceId)
Resume the chart instance indicated by
instanceId . |
void |
setVariables(java.util.UUID instanceId,
org.python.core.PyObject variablesMap)
Updates the chart indicated by
instanceId by copying all of the variables
from the provided variableMap into the chart's scope. |
void |
setVariables(java.util.UUID instanceId,
java.util.UUID stepId,
org.python.core.PyObject variablesMap) |
java.util.UUID |
startChart(java.lang.String chartPath,
java.util.Map<java.lang.String,java.lang.Object> parameters)
Start a chart from the definition at
chartPath . |
public java.util.UUID startChart(java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters) throws java.lang.Exception
SfcScriptingFunctions
chartPath
.startChart
in interface SfcScriptingFunctions
chartPath
- the path to the chart definition.parameters
- the parameters passed to the chart scope.UUID
of the running chart instance.java.lang.Exception
public void cancelChart(java.util.UUID instanceId) throws java.lang.Exception
SfcScriptingFunctions
instanceId
.cancelChart
in interface SfcScriptingFunctions
instanceId
- the UUID
of the chart instance to stop.java.lang.Exception
public void pauseChart(java.util.UUID instanceId) throws java.lang.Exception
SfcScriptingFunctions
instanceId
.pauseChart
in interface SfcScriptingFunctions
instanceId
- the UUID
of the chart instance to pause.java.lang.Exception
public void resumeChart(java.util.UUID instanceId) throws java.lang.Exception
SfcScriptingFunctions
instanceId
.resumeChart
in interface SfcScriptingFunctions
instanceId
- the UUID
of the chart instance to resume.java.lang.Exception
public void debugStep(java.util.UUID instanceId) throws java.lang.Exception
SfcScriptingFunctions
debugStep
in interface SfcScriptingFunctions
java.lang.Exception
public void debugResume(java.util.UUID instanceId) throws java.lang.Exception
SfcScriptingFunctions
debugResume
in interface SfcScriptingFunctions
java.lang.Exception
public java.util.List<ChartInfo> getRunningCharts() throws java.lang.Exception
SfcScriptingFunctions
getRunningCharts
in interface SfcScriptingFunctions
java.lang.Exception
public void setVariables(java.util.UUID instanceId, org.python.core.PyObject variablesMap)
SfcScriptingFunctions
instanceId
by copying all of the variables
from the provided variableMap
into the chart's scope.setVariables
in interface SfcScriptingFunctions
instanceId
- the of the chart instance to update.variablesMap
- a dictionary containing key-value pairs of serializable things to update in chart scope.public void setVariables(java.util.UUID instanceId, java.util.UUID stepId, org.python.core.PyObject variablesMap)
setVariables
in interface SfcScriptingFunctions
public java.util.List<ChartInfo> getRunningCharts(java.lang.String chartPath) throws java.lang.Exception
SfcScriptingFunctions
getRunningCharts
in interface SfcScriptingFunctions
java.lang.Exception
public PyChartScope getVariables(java.util.UUID instanceId) throws java.lang.Exception
SfcScriptingFunctions
getVariables
in interface SfcScriptingFunctions
java.lang.Exception