Package com.inductiveautomation.sfc.client.scripting

Class ClientScriptingFunctions

java.lang.Object

com.inductiveautomation.sfc.client.scripting.ClientScriptingFunctions

All Implemented Interfaces:

SfcScriptingFunctions

public class ClientScriptingFunctions
extends Object
implements SfcScriptingFunctions

Constructor Summary

Constructors

Constructor	Description
ClientScriptingFunctions()

Method Summary

Modifier and Type	Method	Description
void	cancelChart(UUID instanceId)	Cancels the chart instance indicated by instanceId.
void	debugResume(UUID instanceId)	Sends a message to the chart instance stopped at a breakpoint to resume normal operations.
void	debugStep(UUID instanceId)	Sends a message to the chart instance stopped at a breakpoint to step to the next step.
List<ChartInfo>	getRunningCharts()	Returns information about the currently running charts.
List<ChartInfo>	getRunningCharts(String chartPath)	Returns information about the currently running instances of a given chart path.
PyChartScope	getVariables(UUID instanceId)	Returns the chart scope for the specified instance.
void	pauseChart(UUID instanceId)	Pause the chart instance indicated by instanceId.
void	redundantCheckpoint(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(UUID instanceId)	Resume the chart instance indicated by instanceId.
void	setVariables(UUID instanceId, UUID stepId, org.python.core.PyObject variablesMap)
void	setVariables(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.
UUID	startChart(String projectName, String chartPath, Map<String,Object> parameters)	Start a Chart in Project projectName from the definition at chartPath.
UUID	startChart(String chartPath, Map<String,Object> parameters)	Start a chart in Project Project.GLOBAL_PROJECT_NAME from the definition at chartPath.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientScriptingFunctions

public ClientScriptingFunctions()

Method Details

startChart

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

Description copied from interface: SfcScriptingFunctions

Start a chart in Project Project.GLOBAL_PROJECT_NAME from the definition at chartPath.

Specified by:

startChart in interface SfcScriptingFunctions

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:

Exception

startChart

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

Description copied from interface: SfcScriptingFunctions

Start a Chart in Project projectName from the definition at chartPath.

Specified by:

startChart in interface SfcScriptingFunctions

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:

Exception

cancelChart

public void cancelChart(UUID instanceId)
                 throws Exception

Description copied from interface: SfcScriptingFunctions

Cancels the chart instance indicated by instanceId.

Specified by:

cancelChart in interface SfcScriptingFunctions

Parameters:

instanceId - the UUID of the chart instance to stop.

Throws:

Exception

pauseChart

public void pauseChart(UUID instanceId)
                throws Exception

Description copied from interface: SfcScriptingFunctions

Pause the chart instance indicated by instanceId.

Specified by:

pauseChart in interface SfcScriptingFunctions

Parameters:

instanceId - the UUID of the chart instance to pause.

Throws:

Exception

resumeChart

public void resumeChart(UUID instanceId)
                 throws Exception

Description copied from interface: SfcScriptingFunctions

Resume the chart instance indicated by instanceId.

Specified by:

resumeChart in interface SfcScriptingFunctions

Parameters:

instanceId - the UUID of the chart instance to resume.

Throws:

Exception

debugStep

public void debugStep(UUID instanceId)
               throws 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 interface SfcScriptingFunctions

Throws:

Exception

debugResume

public void debugResume(UUID instanceId)
                 throws 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 interface SfcScriptingFunctions

Throws:

Exception

getRunningCharts

public List<ChartInfo> getRunningCharts()
                                 throws Exception

Description copied from interface: SfcScriptingFunctions

Returns information about the currently running charts.

Specified by:

getRunningCharts in interface SfcScriptingFunctions

Returns:

Chart information about all of the currently running charts.

Throws:

Exception

setVariables

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

Description copied from interface: SfcScriptingFunctions

Updates the chart indicated by instanceId by copying all of the variables from the provided variableMap into the chart's scope.

Specified by:

setVariables in interface SfcScriptingFunctions

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(UUID instanceId,
 UUID stepId,
 org.python.core.PyObject variablesMap)

Specified by:

setVariables in interface SfcScriptingFunctions

getRunningCharts

public List<ChartInfo> getRunningCharts(String chartPath)
                                 throws Exception

Description copied from interface: SfcScriptingFunctions

Returns information about the currently running instances of a given chart path.

Specified by:

getRunningCharts in interface SfcScriptingFunctions

Throws:

Exception

getVariables

public PyChartScope getVariables(UUID instanceId)
                          throws 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 interface SfcScriptingFunctions

Throws:

Exception

redundantCheckpoint

public void redundantCheckpoint(UUID instanceId)
                         throws 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 interface SfcScriptingFunctions

Parameters:

instanceId - the UUID of the chart instance to update.

Throws:

Exception - if the redundant peer is not set up or connected, or if the chart does not have redundancy sync enabled.