Class ClientScriptingFunctions
- java.lang.Object
-
- com.inductiveautomation.sfc.client.scripting.ClientScriptingFunctions
-
- All Implemented Interfaces:
SfcScriptingFunctions
public class ClientScriptingFunctions extends java.lang.Object implements SfcScriptingFunctions
-
-
Constructor Summary
Constructors Constructor Description ClientScriptingFunctions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
cancelChart(java.util.UUID instanceId)
Cancels the chart instance indicated byinstanceId
.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 byinstanceId
.void
redundantCheckpoint(java.util.UUID instanceId)
For charts that have the "redundancy sync" setting enabled, this method synchronizes chart and step variables of the specified chart instance across the redundant cluster, allowing the instance to continue where it left off if a redundant failover occurs.void
resumeChart(java.util.UUID instanceId)
Resume the chart instance indicated byinstanceId
.void
setVariables(java.util.UUID instanceId, java.util.UUID stepId, org.python.core.PyObject variablesMap)
void
setVariables(java.util.UUID instanceId, org.python.core.PyObject variablesMap)
Updates the chart indicated byinstanceId
by copying all of the variables from the providedvariableMap
into the chart's scope.java.util.UUID
startChart(java.lang.String projectName, java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters)
Start a Chart in ProjectprojectName
from the definition atchartPath
.java.util.UUID
startChart(java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters)
Start a chart in ProjectProject.GLOBAL_PROJECT_NAME
from the definition atchartPath
.
-
-
-
Method Detail
-
startChart
public java.util.UUID startChart(java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Start a chart in ProjectProject.GLOBAL_PROJECT_NAME
from the definition atchartPath
.- Specified by:
startChart
in interfaceSfcScriptingFunctions
- Parameters:
chartPath
- the path to the chart definition.parameters
- the parameters passed to the chart scope.- Returns:
- The
UUID
of the running chart instance. - Throws:
java.lang.Exception
-
startChart
public java.util.UUID startChart(java.lang.String projectName, java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Start a Chart in ProjectprojectName
from the definition atchartPath
.- Specified by:
startChart
in interfaceSfcScriptingFunctions
- Parameters:
projectName
- the name of the project the chart definition resides in.chartPath
- the path to the chart definition.parameters
- the parameters passed to the chart scope.- Returns:
- The
UUID
of the running chart instance. - Throws:
java.lang.Exception
-
cancelChart
public void cancelChart(java.util.UUID instanceId) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Cancels the chart instance indicated byinstanceId
.- Specified by:
cancelChart
in interfaceSfcScriptingFunctions
- Parameters:
instanceId
- theUUID
of the chart instance to stop.- Throws:
java.lang.Exception
-
pauseChart
public void pauseChart(java.util.UUID instanceId) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Pause the chart instance indicated byinstanceId
.- Specified by:
pauseChart
in interfaceSfcScriptingFunctions
- Parameters:
instanceId
- theUUID
of the chart instance to pause.- Throws:
java.lang.Exception
-
resumeChart
public void resumeChart(java.util.UUID instanceId) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Resume the chart instance indicated byinstanceId
.- Specified by:
resumeChart
in interfaceSfcScriptingFunctions
- Parameters:
instanceId
- theUUID
of the chart instance to resume.- Throws:
java.lang.Exception
-
debugStep
public void debugStep(java.util.UUID instanceId) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Sends a message to the chart instance stopped at a breakpoint to step to the next step.- Specified by:
debugStep
in interfaceSfcScriptingFunctions
- Throws:
java.lang.Exception
-
debugResume
public void debugResume(java.util.UUID instanceId) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Sends a message to the chart instance stopped at a breakpoint to resume normal operations.- Specified by:
debugResume
in interfaceSfcScriptingFunctions
- Throws:
java.lang.Exception
-
getRunningCharts
public java.util.List<ChartInfo> getRunningCharts() throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Returns information about the currently running charts.- Specified by:
getRunningCharts
in interfaceSfcScriptingFunctions
- Returns:
- Chart information about all of the currently running charts.
- Throws:
java.lang.Exception
-
setVariables
public void setVariables(java.util.UUID instanceId, org.python.core.PyObject variablesMap)
Description copied from interface:SfcScriptingFunctions
Updates the chart indicated byinstanceId
by copying all of the variables from the providedvariableMap
into the chart's scope.- Specified by:
setVariables
in interfaceSfcScriptingFunctions
- Parameters:
instanceId
- the of the chart instance to update.variablesMap
- a dictionary containing key-value pairs of serializable things to update in chart scope.
-
setVariables
public void setVariables(java.util.UUID instanceId, java.util.UUID stepId, org.python.core.PyObject variablesMap)
- Specified by:
setVariables
in interfaceSfcScriptingFunctions
-
getRunningCharts
public java.util.List<ChartInfo> getRunningCharts(java.lang.String chartPath) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Returns information about the currently running instances of a given chart path.- Specified by:
getRunningCharts
in interfaceSfcScriptingFunctions
- Throws:
java.lang.Exception
-
getVariables
public PyChartScope getVariables(java.util.UUID instanceId) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
Returns the chart scope for the specified instance. Step scopes for active steps are found under the "activeSteps" key.- Specified by:
getVariables
in interfaceSfcScriptingFunctions
- Throws:
java.lang.Exception
-
redundantCheckpoint
public void redundantCheckpoint(java.util.UUID instanceId) throws java.lang.Exception
Description copied from interface:SfcScriptingFunctions
For charts that have the "redundancy sync" setting enabled, this method synchronizes chart and step variables of the specified chart instance across the redundant cluster, allowing the instance to continue where it left off if a redundant failover occurs.- Specified by:
redundantCheckpoint
in interfaceSfcScriptingFunctions
- Parameters:
instanceId
- the UUID of the chart instance to update.- Throws:
java.lang.Exception
- if the redundant peer is not set up or connected, or if the chart does not have redundancy sync enabled.
-
-