Package com.inductiveautomation.sfc.api

Class ScopeContext

java.lang.Object

com.inductiveautomation.sfc.api.ScopeContext

All Implemented Interfaces:

CommonScopes

public class ScopeContext
extends Object
implements CommonScopes

Created by colby.clegg on 2/2/2015.

Field Summary

Fields inherited from interface com.inductiveautomation.sfc.api.CommonScopes

CHART, PARENT, PREVIOUS, ROOT, STEP

Constructor Summary

Constructors

Constructor	Description
ScopeContext(PyChartScope chart)

Method Summary

Modifier and Type	Method	Description
PyChartScope	getChartScope()
PyChartScope	getPrevious()	Returns the previous step's scope, in the context of a transition who has an active step preceeding it.
PyChartScope	getRoot()	Goes up the chart scope's parent chain to find the root scope.
PyChartScope	getStepOrPrevious()	This returns the "step" scope, regardless of whether it represents the current step, in the context of an executing step, or "previous step", in the context of a transition.
PyChartScope	getStepScope()	Returns the current step's scope, in the context of the step.
Optional<PyChartScope>	locate(String id)
ScopeContext	setChartScope(PyChartScope chart)
ScopeContext	setPreviousScope(PyChartScope stepScope)
ScopeContext	setStepScope(PyChartScope step)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScopeContext

public ScopeContext(PyChartScope chart)

Method Details

setStepScope

public ScopeContext setStepScope(PyChartScope step)

setPreviousScope

public ScopeContext setPreviousScope(PyChartScope stepScope)

setChartScope

public ScopeContext setChartScope(PyChartScope chart)

getChartScope

public PyChartScope getChartScope()

getStepScope

public PyChartScope getStepScope()

Returns the current step's scope, in the context of the step. If the current context is a transition, "previous" is the step scope, or you can call getStepOrPrevious().

getPrevious

public PyChartScope getPrevious()

Returns the previous step's scope, in the context of a transition who has an active step preceeding it.

getStepOrPrevious

public PyChartScope getStepOrPrevious()

This returns the "step" scope, regardless of whether it represents the current step, in the context of an executing step, or "previous step", in the context of a transition.

getRoot

public PyChartScope getRoot()

Goes up the chart scope's parent chain to find the root scope.

locate

public Optional<PyChartScope> locate(String id)