Package com.inductiveautomation.sfc.rpc

Interface SfcRpcFunctions

All Superinterfaces:

SfcScriptingFunctions

public interface SfcRpcFunctions
extends SfcScriptingFunctions

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.
ChartStatus	getChartStatus(UUID instanceId, boolean includeModel)	Get the ChartStatus for a chart.
EventTimeline	loadRecording(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 Details

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