Package com.inductiveautomation.sfc.scripting

Class SfcScriptingFunctionsPyWrapper

  • public class SfcScriptingFunctionsPyWrapper
extends java.lang.Object
    Created by carl.gould on 7/22/2014.

    This is the actual class that is added to the scripting system to implement the SFC functions. It is more python friendly than the methods from the SfcScriptingFunctions interface.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cancelChart​(java.lang.String instanceId)  
      Dataset getRunningCharts()  
      Dataset getRunningCharts​(java.lang.String chartPath)  
      PyChartScope getVariables​(java.lang.String instanceId)  
      void pauseChart​(java.lang.String instanceId)  
      void redundantCheckpoint​(java.lang.String instanceId)  
      void resumeChart​(java.lang.String instanceId)  
      void setVariable​(java.lang.String instanceId, java.lang.String variableName, java.lang.Object variableValue)  
      void setVariable​(java.lang.String instanceId, java.lang.String stepId, java.lang.String variableName, java.lang.Object variableValue)  
      void setVariables​(java.lang.String instanceId, java.lang.String stepId, org.python.core.PyObject variablesMap)  
      void setVariables​(java.lang.String instanceId, org.python.core.PyObject variablesMap)  
      java.lang.String startChart​(java.lang.String projectName, java.lang.String chartPath, java.util.Map<java.lang.String,​java.lang.Object> parameters)  
      java.lang.String startChart​(java.lang.String chartPath, java.util.Map<java.lang.String,​java.lang.Object> parameters)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SfcScriptingFunctionsPyWrapper

        public SfcScriptingFunctionsPyWrapper​(SfcScriptingFunctions delegate)

    • Method Detail

      • startChart

        public java.lang.String startChart​(java.lang.String chartPath,
                                   java.util.Map<java.lang.String,​java.lang.Object> parameters)
                            throws java.lang.Exception
        Throws:
        java.lang.Exception

      • startChart

        public java.lang.String startChart​(java.lang.String projectName,
                                   java.lang.String chartPath,
                                   java.util.Map<java.lang.String,​java.lang.Object> parameters)
                            throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getRunningCharts

        public Dataset getRunningCharts()
                         throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getRunningCharts

        public Dataset getRunningCharts​(java.lang.String chartPath)
                         throws java.lang.Exception
        Throws:
        java.lang.Exception

      • cancelChart

        public void cancelChart​(java.lang.String instanceId)
                 throws java.lang.Exception
        Throws:
        java.lang.Exception

      • pauseChart

        public void pauseChart​(java.lang.String instanceId)
                throws java.lang.Exception
        Throws:
        java.lang.Exception

      • resumeChart

        public void resumeChart​(java.lang.String instanceId)
                 throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getVariables

        public PyChartScope getVariables​(java.lang.String instanceId)
                          throws java.lang.Exception
        Throws:
        java.lang.Exception

      • setVariable

        public void setVariable​(java.lang.String instanceId,
                        java.lang.String variableName,
                        java.lang.Object variableValue)

      • setVariable

        public void setVariable​(java.lang.String instanceId,
                        java.lang.String stepId,
                        java.lang.String variableName,
                        java.lang.Object variableValue)

      • setVariables

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

      • setVariables

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

      • redundantCheckpoint

        public void redundantCheckpoint​(java.lang.String instanceId)
                         throws java.lang.Exception
        Throws:
        java.lang.Exception