Package com.inductiveautomation.sfc.api

Interface ChartContext

public interface ChartContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_MDC_CHARTNAME
static final String	KEY_MDC_CHARTUUID
static final String	KEY_MDC_STEPNAME
static final ThreadFactory	ScheduledThreadFactory
static final ExecutorService	SharedExecutor
static final ScheduledExecutorService	SharedScheduler
static final ThreadFactory	ThreadFactory

Method Summary

Modifier and Type	Method	Description
void	abort(Throwable cause)
void	debug()	This will block until step or resume is called, if debugging is enabled, and the step has a breakpoint (or it's the next step after a "step" command).
ChartDefinition	getChartDefinition()
String	getChartPath()
PyChartScope	getChartScope()
ChartElement	getElement(UUID elementId)
List<ChartElement>	getElements()
ExecutionQueue	getExecutionQueue()
GatewayContext	getGatewayContext()
UUID	getInstanceId()
MDCUtils.MDCDetails	getLogDetails()
ProjectResourceId	getResourceId()
ScopeLocator	getScopeLocator()
ScriptManager	getScriptManager()
boolean	isRunning()	Indicates that the chart is in a running state and the elements should transition as necessary.
void	pause()
boolean	shouldDebug(UUID step)

Field Details

KEY_MDC_CHARTNAME

static final String KEY_MDC_CHARTNAME

See Also:

• Constant Field Values

KEY_MDC_CHARTUUID

static final String KEY_MDC_CHARTUUID

See Also:

• Constant Field Values

KEY_MDC_STEPNAME

static final String KEY_MDC_STEPNAME

See Also:

• Constant Field Values

ThreadFactory

static final ThreadFactory ThreadFactory

SharedExecutor

static final ExecutorService SharedExecutor

ScheduledThreadFactory

static final ThreadFactory ScheduledThreadFactory

SharedScheduler

static final ScheduledExecutorService SharedScheduler

Method Details

abort

void abort(Throwable cause)

pause

void pause()

shouldDebug

boolean shouldDebug(UUID step)

debug

void debug()

This will block until step or resume is called, if debugging is enabled, and the step has a breakpoint (or it's the next step after a "step" command).

getInstanceId

UUID getInstanceId()

getChartPath

String getChartPath()

getChartScope

PyChartScope getChartScope()

getScopeLocator

ScopeLocator getScopeLocator()

getElements

List<ChartElement> getElements()

getResourceId

ProjectResourceId getResourceId()

getChartDefinition

ChartDefinition getChartDefinition()

getElement

ChartElement getElement(UUID elementId)

getExecutionQueue

ExecutionQueue getExecutionQueue()

getGatewayContext

GatewayContext getGatewayContext()

getScriptManager

ScriptManager getScriptManager()

isRunning

boolean isRunning()

Indicates that the chart is in a running state and the elements should transition as necessary. *

getLogDetails

MDCUtils.MDCDetails getLogDetails()