com.inductiveautomation.sfc.api

Interface ChartManagerService

All Superinterfaces:

ModuleService

public interface ChartManagerService
extends ModuleService

Method Summary

Modifier and Type	Method and Description
void	addChartObserver(ChartObserver observer) Registers a ChartObserver that will be notified of chart and element events that occur.
void	cancelChart(java.util.UUID instanceId) Cancel the chart instance identified by instanceId.
void	pauseChart(java.util.UUID instanceId) Pause the chart instance identified by instanceId.
void	register(StepFactory factory) Register a StepFactory.
void	registerScopeLocator(ScopeLocator locator) Register a ScopeLocator, which will be used by expressions and scripting functions to resolve special scopes provided or identified by modules.
void	removeChartObserver(ChartObserver observer) Removes a previously registered ChartObserver.
void	resumeChart(java.util.UUID instanceId) Resume the chart instance identified by instanceId.
java.util.UUID	startChart(java.lang.String chartPath, java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String user) Start an instance of the chart defined at chartPath.
void	unregister(StepFactory factory) Unregister a StepFactory.
void	unregisterScopeLocator(ScopeLocator locator) Unregister a previously registered scope locator.

Method Detail

register

void register(StepFactory factory)

Register a StepFactory.

Parameters:

factory - The StepFactory to register.

unregister

void unregister(StepFactory factory)

Unregister a StepFactory.

Parameters:

factory - The StepFactory to unregister.

registerScopeLocator

void registerScopeLocator(ScopeLocator locator)

Register a ScopeLocator, which will be used by expressions and scripting functions to resolve special scopes provided or identified by modules.

unregisterScopeLocator

void unregisterScopeLocator(ScopeLocator locator)

Unregister a previously registered scope locator.

startChart

java.util.UUID startChart(java.lang.String chartPath,
                          java.util.Map<java.lang.String,java.lang.Object> parameters,
                          java.lang.String user)
                   throws java.lang.Exception

Start an instance of the chart defined at chartPath.

Parameters:

chartPath - the chart path.

parameters - parameters to be made available start in the chart's scope.

user - the user requesting the chart be started.

Returns:

the UUID of the chart instance.

Throws:

java.lang.Exception - if the chart cannot be started for any reason.

cancelChart

void cancelChart(java.util.UUID instanceId)

Cancel the chart instance identified by instanceId.

Parameters:

instanceId - the instance id of the chart to cancel.

pauseChart

void pauseChart(java.util.UUID instanceId)

Pause the chart instance identified by instanceId.

Parameters:

instanceId - the instance id of the chart to pause.

resumeChart

void resumeChart(java.util.UUID instanceId)

Resume the chart instance identified by instanceId.

Parameters:

instanceId - the instance id of the chart to resume.

addChartObserver

void addChartObserver(ChartObserver observer)

Registers a ChartObserver that will be notified of chart and element events that occur.

removeChartObserver

void removeChartObserver(ChartObserver observer)

Removes a previously registered ChartObserver.