|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface State
A representation of the model object 'State'.
A State is the main entity in a SyncChart. States are located in a Region
.
A SyncChart itself is represented by a top-level root Region that contains
exactly one root State. Every State may contain multiple parallel Regions
whereas a Region contains multiple States. This allows nested State
machines with parallelism.
A State may be initial or final or both. An initial State is the entry State of a Region. SyncCharts may only have one initial State per Region. A final State indcates that its parent Region has terminated and nothing needs to be done in that Region and its parent State may be left via a normal termination transition.
A State is also a Scope and hence may carry an interface declaration and is identified by id and label.
States have a type to indicate different properties of States. See StateType
.
The following features are supported:
SyncchartsPackage.getState()
Field Summary | |
---|---|
static String |
copyright
|
Method Summary | |
---|---|
EList<Transition> |
getIncomingTransitions()
Returns the value of the 'Incoming Transitions' reference list. |
EList<Transition> |
getOutgoingTransitions()
Returns the value of the 'Outgoing Transitions' containment reference list. |
Region |
getParentRegion()
Returns the value of the 'Parent Region' container reference. |
EList<Region> |
getRegions()
Returns the value of the 'Regions' containment reference list. |
StateType |
getType()
Returns the value of the 'Type' attribute. |
boolean |
isIsFinal()
Returns the value of the 'Is Final' attribute. |
boolean |
isIsInitial()
Returns the value of the 'Is Initial' attribute. |
void |
setIsFinal(boolean value)
Sets the value of the ' Is Final ' attribute. |
void |
setIsInitial(boolean value)
Sets the value of the ' Is Initial ' attribute. |
void |
setParentRegion(Region value)
Sets the value of the ' Parent Region ' container reference. |
void |
setType(StateType value)
Sets the value of the ' Type ' attribute. |
Methods inherited from interface de.cau.cs.kieler.synccharts.Scope |
---|
getBodyContents, getBodyReference, getBodyText, getEntryActions, getExitActions, getId, getInnerActions, getInterfaceDeclaration, getLabel, getRenamings, getSignals, getSuspensionTrigger, getVariables, setBodyContents, setBodyReference, setId, setInterfaceDeclaration, setLabel, setSuspensionTrigger |
Methods inherited from interface de.cau.cs.kieler.core.annotations.Annotatable |
---|
getAllAnnotations, getAnnotation, getAnnotations, removeAllAnnotations |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Field Detail |
---|
static final String copyright
Method Detail |
---|
StateType getType()
StateType
.
If the meaning of the 'Type' attribute isn't clear, there really should be more of a description here...
StateType
,
setType(StateType)
,
SyncchartsPackage.getState_Type()
required | = | true |
void setType(StateType value)
Type
' attribute.
value
- the new value of the 'Type' attribute.StateType
,
getType()
EList<Region> getRegions()
Region
.
It is bidirectional and its opposite is 'Parent State
'.
If the meaning of the 'Regions' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getState_Regions()
,
Region.getParentState()
opposite | = | parentState |
containment | = | true |
Region getParentRegion()
States
'.
If the meaning of the 'Parent Region' container reference isn't clear, there really should be more of a description here...
setParentRegion(Region)
,
SyncchartsPackage.getState_ParentRegion()
,
Region.getStates()
opposite | = | states |
required | = | true |
transient | = | false |
void setParentRegion(Region value)
Parent Region
' container reference.
value
- the new value of the 'Parent Region' container reference.getParentRegion()
boolean isIsInitial()
If the meaning of the 'Is Initial' attribute isn't clear, there really should be more of a description here...
setIsInitial(boolean)
,
SyncchartsPackage.getState_IsInitial()
void setIsInitial(boolean value)
Is Initial
' attribute.
value
- the new value of the 'Is Initial' attribute.isIsInitial()
boolean isIsFinal()
If the meaning of the 'Is Final' attribute isn't clear, there really should be more of a description here...
setIsFinal(boolean)
,
SyncchartsPackage.getState_IsFinal()
void setIsFinal(boolean value)
Is Final
' attribute.
value
- the new value of the 'Is Final' attribute.isIsFinal()
EList<Transition> getOutgoingTransitions()
Transition
.
It is bidirectional and its opposite is 'Source State
'.
If the meaning of the 'Outgoing Transitions' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getState_OutgoingTransitions()
,
Transition.getSourceState()
opposite | = | sourceState |
containment | = | true |
EList<Transition> getIncomingTransitions()
Transition
.
It is bidirectional and its opposite is 'Target State
'.
If the meaning of the 'Incoming Transitions' reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getState_IncomingTransitions()
,
Transition.getTargetState()
opposite | = | targetState |
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |