Package com.inductiveautomation.sfc

Interface ChartObserver

public interface ChartObserver

A ChartObserver is notified when the chart or chart elements change state.

Method Summary

Modifier and Type	Method	Description
void	onBeforeChartStart(ChartContext chartContext)	Provides the full chart context before the chart is started.
void	onChartStateChange(UUID instanceId, ChartStateEnum previousState, ChartStateEnum currentState)
void	onElementStateChange(UUID chartInstanceId, UUID elementId, ElementStateEnum previousState, ElementStateEnum currentState)
default 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.

Method Details

onBeforeChartStart

void onBeforeChartStart(ChartContext chartContext)

Provides the full chart context before the chart is started. Provides an opportunity to modify chart scope or perform other operations before the chart begins.

onChartStateChange

void onChartStateChange(UUID instanceId,
 ChartStateEnum previousState,
 ChartStateEnum currentState)

onElementStateChange

void onElementStateChange(UUID chartInstanceId,
 UUID elementId,
 ElementStateEnum previousState,
 ElementStateEnum currentState)

redundantCheckpoint

default 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.