Package com.inductiveautomation.sfc.rpc

Interface SfcRpcFunctions

All Superinterfaces:

SfcScriptingFunctions

public interface SfcRpcFunctions
extends SfcScriptingFunctions

Method Summary

Modifier and Type	Method	Description
java.util.List<RecordingMeta>	browseRecordings(java.util.Date start, java.util.Date end, java.lang.String chartPathFilter, java.lang.String instanceUuidFilter)	Returns information about recordings that match the provided filters.
ChartStatus	getChartStatus(java.util.UUID instanceId, boolean includeModel)	Get the ChartStatus for a chart.
EventTimeline	loadRecording(java.lang.String file)

Methods inherited from interface com.inductiveautomation.sfc.scripting.SfcScriptingFunctions

cancelChart, debugResume, debugStep, getRunningCharts, getRunningCharts, getVariables, pauseChart, redundantCheckpoint, resumeChart, setVariables, setVariables, startChart, startChart

Method Detail

getChartStatus

@Nullable
ChartStatus getChartStatus(java.util.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

java.util.List<RecordingMeta> browseRecordings(java.util.Date start,
                                               java.util.Date end,
                                               java.lang.String chartPathFilter,
                                               java.lang.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(java.lang.String file)
                     throws java.lang.Exception

Throws:

java.lang.Exception