Package com.inductiveautomation.sfc.rpc

Interface SfcRpcFunctions

All Known Implementing Classes:
ClientScriptingFunctions
public interface SfcRpcFunctions

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ProtoRpcSerializer
    SERIALIZER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<RecordingMeta>
    browseRecordings(Date start, Date end, String chartPathFilter, String instanceUuidFilter)
    Returns information about recordings that match the provided filters.
    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>
    getAllRunningCharts()
    Returns information about the currently running charts.
    ChartStatus
    getChartStatus(UUID instanceId, boolean includeModel)
    Get the ChartStatus for a chart.
    List<ChartInfo>
    getRunningChartsForId(ResourceId resourceId)
    Returns information about the currently running instances of a resource.
    List<ChartInfo>
    getRunningChartsForPath(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.
    EventTimeline
    loadRecording(String file)
     
    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
    setStepVariables(UUID instanceId, UUID stepId, org.python.core.PyObject variableMap)
    Updates the chart indicated by instanceId by copying all of the variables from the provided variableMap into the charts specified step scope.
    void
    setVariables(UUID instanceId, org.python.core.PyObject variableMap)
    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 username, String chartPath, Map<String,Object> parameters)
    Start a Chart in Project projectName from the definition at chartPath.

  • Field Details

  • Method Details

    • startChart

      UUID startChart(String projectName, String username, String chartPath, Map<String,Object> parameters) throws Exception
      Start a Chart in Project projectName from the definition at chartPath.
      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

      void cancelChart(UUID instanceId)
      Cancels the chart instance indicated by instanceId.
      Parameters:
      instanceId - the UUID of the chart instance to stop.

    • pauseChart

      void pauseChart(UUID instanceId)
      Pause the chart instance indicated by instanceId.
      Parameters:
      instanceId - the UUID of the chart instance to pause.

    • resumeChart

      void resumeChart(UUID instanceId)
      Resume the chart instance indicated by instanceId.
      Parameters:
      instanceId - the UUID of the chart instance to resume.

    • debugStep

      void debugStep(UUID instanceId)
      Sends a message to the chart instance stopped at a breakpoint to step to the next step.

    • debugResume

      void debugResume(UUID instanceId)
      Sends a message to the chart instance stopped at a breakpoint to resume normal operations.

    • getAllRunningCharts

      List<ChartInfo> getAllRunningCharts()
      Returns information about the currently running charts.
      Returns:
      Chart information about all of the currently running charts.

    • getRunningChartsForId

      List<ChartInfo> getRunningChartsForId(ResourceId resourceId)
      Returns information about the currently running instances of a resource.

    • getRunningChartsForPath

      List<ChartInfo> getRunningChartsForPath(String chartPath) throws Exception
      Returns information about the currently running instances of a given chart path.
      Throws:
      Exception

    • setVariables

      void setVariables(UUID instanceId, org.python.core.PyObject variableMap)
      Updates the chart indicated by instanceId by copying all of the variables from the provided variableMap into the chart's scope.
      Parameters:
      instanceId - the of the chart instance to update.
      variableMap - a dictionary containing key-value pairs of serializable things to update in chart scope.

    • setStepVariables

      void setStepVariables(UUID instanceId, UUID stepId, org.python.core.PyObject variableMap)
      Updates the chart indicated by instanceId by copying all of the variables from the provided variableMap into the charts specified step scope.
      Parameters:
      instanceId - the of the chart instance to update.
      stepId - the of the running step to update.
      variableMap - a dictionary containing key-value pairs of serializable things to update in chart scope.

    • getVariables

      PyChartScope getVariables(UUID instanceId) throws Exception
      Returns the chart scope for the specified instance. Step scopes for active steps are found under the "activeSteps" key.
      Throws:
      Exception

    • getChartStatus

      @Nullable ChartStatus getChartStatus(UUID instanceId, boolean includeModel)
      Get the ChartStatus for a chart.
      Parameters:
      instanceId - the instance id of the chart.
      includeModel - if true, include the ChartUIModel in the ChartStatus.
      Returns:
      the ChartStatus, or null if no chart for instanceId exists.

    • browseRecordings

      List<RecordingMeta> browseRecordings(Date start, Date end, String chartPathFilter, String instanceUuidFilter)
      Returns information about recordings that match the provided filters. If a filter parameter is null it is not used.
      Parameters:
      chartPathFilter - a string that will be used to match the chart path of the recording.

    • loadRecording

      EventTimeline loadRecording(String file) throws Exception
      Throws:
      Exception

    • redundantCheckpoint

      void redundantCheckpoint(UUID instanceId) throws Exception
      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.
      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.