|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Scope
A representation of the model object 'Scope'. A Scope is the abstract superclass for State and Region.
The fields label and id are there to identify such object, where the label may be an arbitrary String and the id may be used as identifier in programming languages. Therefore the id should be unique within its containing scope, should start with a word character (letter, underscore) and should not contain whitespace.
The interfaceDeclaration is a String text field containing the interface declaration in a textual representation. The user of a model instance needs to take care that this textual representation gets parsed correctly and translated into proper Interface objects (e.g. Signals and Variables). For example the SyncCharts editor uses an Xtext grammar/parser to do this.
A Scope may carry lists of entry-, inner- or exit Action
s that are executed on either Scope entry, staying a tick
in the Scope or exiting the Scope. A suspensionTrigger Action guards the suspension of a Scope. When this trigger
is evaluated to true, then the contents of the Scope is no longer evaluated until the guard gets false again.
The following features are supported:
Id
Label
Signals
Variables
Suspension Trigger
Exit Actions
Inner Actions
Entry Actions
Body Reference
Body Contents
Body Text
Renamings
Interface Declaration
SyncchartsPackage.getScope()
abstract | = | true |
Field Summary | |
---|---|
static String |
copyright
|
Method Summary | |
---|---|
EObject |
getBodyContents()
Returns the value of the 'Body Contents' containment reference. |
EObject |
getBodyReference()
Returns the value of the 'Body Reference' reference. |
EList<TextualCode> |
getBodyText()
Returns the value of the 'Body Text' containment reference list. |
EList<Action> |
getEntryActions()
Returns the value of the 'Entry Actions' containment reference list. |
EList<Action> |
getExitActions()
Returns the value of the 'Exit Actions' containment reference list. |
String |
getId()
Returns the value of the 'Id' attribute. |
EList<Action> |
getInnerActions()
Returns the value of the 'Inner Actions' containment reference list. |
String |
getInterfaceDeclaration()
Returns the value of the 'Interface Declaration' attribute. |
String |
getLabel()
Returns the value of the 'Label' attribute. |
EList<Substitution> |
getRenamings()
Returns the value of the 'Renamings' containment reference list. |
EList<Signal> |
getSignals()
Returns the value of the 'Signals' containment reference list. |
Action |
getSuspensionTrigger()
Returns the value of the 'Suspension Trigger' containment reference. |
EList<Variable> |
getVariables()
Returns the value of the 'Variables' containment reference list. |
void |
setBodyContents(EObject value)
Sets the value of the ' Body Contents ' containment reference. |
void |
setBodyReference(EObject value)
Sets the value of the ' Body Reference ' reference. |
void |
setId(String value)
Sets the value of the ' Id ' attribute. |
void |
setInterfaceDeclaration(String value)
Sets the value of the ' Interface Declaration ' attribute. |
void |
setLabel(String value)
Sets the value of the ' Label ' attribute. |
void |
setSuspensionTrigger(Action value)
Sets the value of the ' Suspension Trigger ' containment reference. |
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 |
---|
String getId()
If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...
setId(String)
,
SyncchartsPackage.getScope_Id()
void setId(String value)
Id
' attribute.
value
- the new value of the 'Id' attribute.getId()
String getLabel()
If the meaning of the 'Label' attribute isn't clear, there really should be more of a description here...
setLabel(String)
,
SyncchartsPackage.getScope_Label()
void setLabel(String value)
Label
' attribute.
value
- the new value of the 'Label' attribute.getLabel()
EList<Signal> getSignals()
Signal
.
If the meaning of the 'Signals' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getScope_Signals()
containment | = | true |
EList<Variable> getVariables()
Variable
.
If the meaning of the 'Variables' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getScope_Variables()
containment | = | true |
Action getSuspensionTrigger()
If the meaning of the 'Suspension Trigger' containment reference isn't clear, there really should be more of a description here...
setSuspensionTrigger(Action)
,
SyncchartsPackage.getScope_SuspensionTrigger()
containment | = | true |
void setSuspensionTrigger(Action value)
Suspension Trigger
' containment reference.
value
- the new value of the 'Suspension Trigger' containment reference.getSuspensionTrigger()
EList<Action> getExitActions()
Action
.
If the meaning of the 'Exit Actions' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getScope_ExitActions()
containment | = | true |
EList<Action> getInnerActions()
Action
.
If the meaning of the 'Inner Actions' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getScope_InnerActions()
containment | = | true |
EList<Action> getEntryActions()
Action
.
If the meaning of the 'Entry Actions' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getScope_EntryActions()
containment | = | true |
EObject getBodyReference()
If the meaning of the 'Body Reference' reference isn't clear, there really should be more of a description here...
setBodyReference(EObject)
,
SyncchartsPackage.getScope_BodyReference()
void setBodyReference(EObject value)
Body Reference
' reference.
value
- the new value of the 'Body Reference' reference.getBodyReference()
EObject getBodyContents()
If the meaning of the 'Body Contents' containment reference isn't clear, there really should be more of a description here...
setBodyContents(EObject)
,
SyncchartsPackage.getScope_BodyContents()
containment | = | true |
void setBodyContents(EObject value)
Body Contents
' containment reference.
value
- the new value of the 'Body Contents' containment reference.getBodyContents()
EList<TextualCode> getBodyText()
TextualCode
.
If the meaning of the 'Body Text' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getScope_BodyText()
containment | = | true |
EList<Substitution> getRenamings()
Substitution
.
It is bidirectional and its opposite is 'Parent Scope
'.
If the meaning of the 'Renamings' containment reference list isn't clear, there really should be more of a description here...
SyncchartsPackage.getScope_Renamings()
,
Substitution.getParentScope()
opposite | = | parentScope |
containment | = | true |
String getInterfaceDeclaration()
If the meaning of the 'Interface Declaration' attribute isn't clear, there really should be more of a description here...
setInterfaceDeclaration(String)
,
SyncchartsPackage.getScope_InterfaceDeclaration()
dataType | = | de.cau.cs.kieler.synccharts.Parsable |
void setInterfaceDeclaration(String value)
Interface Declaration
' attribute.
value
- the new value of the 'Interface Declaration' attribute.getInterfaceDeclaration()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |