de.cau.cs.kieler.synccharts
Interface State

All Superinterfaces:
Annotatable, EObject, Notifier, Scope
All Known Implementing Classes:
StateImpl

public interface State
extends Scope

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:

See Also:
SyncchartsPackage.getState()
Rating red
Generated:
This code was automatically generated.
Model element

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

copyright

static final String copyright

See Also:
Constant Field Values
Generated:
This code was automatically generated.
Method Detail

getType

StateType getType()
Returns the value of the 'Type' attribute. The literals are from the enumeration StateType.

If the meaning of the 'Type' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Type' attribute.
See Also:
StateType, setType(StateType), SyncchartsPackage.getState_Type()
Generated:
This code was automatically generated.
Model element:
required=true

setType

void setType(StateType value)
Sets the value of the 'Type' attribute.

Parameters:
value - the new value of the 'Type' attribute.
See Also:
StateType, getType()
Generated:
This code was automatically generated.

getRegions

EList<Region> getRegions()
Returns the value of the 'Regions' containment reference list. The list contents are of type 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...

Returns:
the value of the 'Regions' containment reference list.
See Also:
SyncchartsPackage.getState_Regions(), Region.getParentState()
Generated:
This code was automatically generated.
Model element:
opposite=parentState
containment=true

getParentRegion

Region getParentRegion()
Returns the value of the 'Parent Region' container reference. It is bidirectional and its opposite is 'States'.

If the meaning of the 'Parent Region' container reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Parent Region' container reference.
See Also:
setParentRegion(Region), SyncchartsPackage.getState_ParentRegion(), Region.getStates()
Generated:
This code was automatically generated.
Model element:
opposite=states
required=true
transient=false

setParentRegion

void setParentRegion(Region value)
Sets the value of the 'Parent Region' container reference.

Parameters:
value - the new value of the 'Parent Region' container reference.
See Also:
getParentRegion()
Generated:
This code was automatically generated.

isIsInitial

boolean isIsInitial()
Returns the value of the 'Is Initial' attribute.

If the meaning of the 'Is Initial' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Initial' attribute.
See Also:
setIsInitial(boolean), SyncchartsPackage.getState_IsInitial()
Generated:
This code was automatically generated.
Model element

setIsInitial

void setIsInitial(boolean value)
Sets the value of the 'Is Initial' attribute.

Parameters:
value - the new value of the 'Is Initial' attribute.
See Also:
isIsInitial()
Generated:
This code was automatically generated.

isIsFinal

boolean isIsFinal()
Returns the value of the 'Is Final' attribute.

If the meaning of the 'Is Final' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Is Final' attribute.
See Also:
setIsFinal(boolean), SyncchartsPackage.getState_IsFinal()
Generated:
This code was automatically generated.
Model element

setIsFinal

void setIsFinal(boolean value)
Sets the value of the 'Is Final' attribute.

Parameters:
value - the new value of the 'Is Final' attribute.
See Also:
isIsFinal()
Generated:
This code was automatically generated.

getOutgoingTransitions

EList<Transition> getOutgoingTransitions()
Returns the value of the 'Outgoing Transitions' containment reference list. The list contents are of type 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...

Returns:
the value of the 'Outgoing Transitions' containment reference list.
See Also:
SyncchartsPackage.getState_OutgoingTransitions(), Transition.getSourceState()
Generated:
This code was automatically generated.
Model element:
opposite=sourceState
containment=true

getIncomingTransitions

EList<Transition> getIncomingTransitions()
Returns the value of the 'Incoming Transitions' reference list. The list contents are of type 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...

Returns:
the value of the 'Incoming Transitions' reference list.
See Also:
SyncchartsPackage.getState_IncomingTransitions(), Transition.getTargetState()
Generated:
This code was automatically generated.
Model element:
opposite=targetState