Package com.inductiveautomation.sfc.api
Interface ChartContext
-
public interface ChartContext
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
KEY_MDC_CHARTNAME
static java.lang.String
KEY_MDC_CHARTUUID
static java.lang.String
KEY_MDC_STEPNAME
static java.util.concurrent.ThreadFactory
ScheduledThreadFactory
static java.util.concurrent.ExecutorService
SharedExecutor
static java.util.concurrent.ScheduledExecutorService
SharedScheduler
static java.util.concurrent.ThreadFactory
ThreadFactory
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
abort(java.lang.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()
java.lang.String
getChartPath()
PyChartScope
getChartScope()
ChartElement
getElement(java.util.UUID elementId)
java.util.List<ChartElement>
getElements()
ExecutionQueue
getExecutionQueue()
GatewayContext
getGatewayContext()
java.util.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(java.util.UUID step)
-
-
-
Field Detail
-
KEY_MDC_CHARTNAME
static final java.lang.String KEY_MDC_CHARTNAME
- See Also:
- Constant Field Values
-
KEY_MDC_CHARTUUID
static final java.lang.String KEY_MDC_CHARTUUID
- See Also:
- Constant Field Values
-
KEY_MDC_STEPNAME
static final java.lang.String KEY_MDC_STEPNAME
- See Also:
- Constant Field Values
-
ThreadFactory
static final java.util.concurrent.ThreadFactory ThreadFactory
-
SharedExecutor
static final java.util.concurrent.ExecutorService SharedExecutor
-
ScheduledThreadFactory
static final java.util.concurrent.ThreadFactory ScheduledThreadFactory
-
SharedScheduler
static final java.util.concurrent.ScheduledExecutorService SharedScheduler
-
-
Method Detail
-
abort
void abort(java.lang.Throwable cause)
-
pause
void pause()
-
shouldDebug
boolean shouldDebug(java.util.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
java.util.UUID getInstanceId()
-
getChartPath
java.lang.String getChartPath()
-
getChartScope
PyChartScope getChartScope()
-
getScopeLocator
ScopeLocator getScopeLocator()
-
getElements
java.util.List<ChartElement> getElements()
-
getResourceId
ProjectResourceId getResourceId()
-
getChartDefinition
ChartDefinition getChartDefinition()
-
getElement
ChartElement getElement(java.util.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()
-
-