Package com.inductiveautomation.sfc.client.scripting

Class 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 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 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 by instanceId.
      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 by instanceId by copying all of the variables from the provided variableMap 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 Project projectName from the definition at chartPath.
      java.util.UUID startChart​(java.lang.String chartPath, java.util.Map<java.lang.String,​java.lang.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 Detail

      • ClientScriptingFunctions

        public ClientScriptingFunctions()

    • 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 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:
        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 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:
        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 by instanceId.
        Specified by:
        cancelChart in interface SfcScriptingFunctions
        Parameters:
        instanceId - the UUID 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 by instanceId.
        Specified by:
        pauseChart in interface SfcScriptingFunctions
        Parameters:
        instanceId - the UUID 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 by instanceId.
        Specified by:
        resumeChart in interface SfcScriptingFunctions
        Parameters:
        instanceId - the UUID 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 interface SfcScriptingFunctions
        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 interface SfcScriptingFunctions
        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 interface SfcScriptingFunctions
        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 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​(java.util.UUID instanceId,
                         java.util.UUID stepId,
                         org.python.core.PyObject variablesMap)
        Specified by:
        setVariables in interface SfcScriptingFunctions

      • 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 interface SfcScriptingFunctions
        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 interface SfcScriptingFunctions
        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 interface SfcScriptingFunctions
        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.