de.cau.cs.kieler.synccharts
Interface Scope

All Superinterfaces:
Annotatable, EObject, Notifier
All Known Subinterfaces:
Region, State
All Known Implementing Classes:
RegionImpl, ScopeImpl, StateImpl

public interface Scope
extends Annotatable

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 Actions 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:

See Also:
SyncchartsPackage.getScope()
Rating red
Generated:
This code was automatically generated.
Model element:
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

copyright

static final String copyright

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

getId

String getId()
Returns the value of the 'Id' attribute.

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

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), SyncchartsPackage.getScope_Id()
Generated:
This code was automatically generated.
Model element

setId

void setId(String value)
Sets the value of the 'Id' attribute.

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

getLabel

String getLabel()
Returns the value of the 'Label' attribute.

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

Returns:
the value of the 'Label' attribute.
See Also:
setLabel(String), SyncchartsPackage.getScope_Label()
Generated:
This code was automatically generated.
Model element

setLabel

void setLabel(String value)
Sets the value of the 'Label' attribute.

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

getSignals

EList<Signal> getSignals()
Returns the value of the 'Signals' containment reference list. The list contents are of type Signal.

If the meaning of the 'Signals' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Signals' containment reference list.
See Also:
SyncchartsPackage.getScope_Signals()
Generated:
This code was automatically generated.
Model element:
containment=true

getVariables

EList<Variable> getVariables()
Returns the value of the 'Variables' containment reference list. The list contents are of type Variable.

If the meaning of the 'Variables' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Variables' containment reference list.
See Also:
SyncchartsPackage.getScope_Variables()
Generated:
This code was automatically generated.
Model element:
containment=true

getSuspensionTrigger

Action getSuspensionTrigger()
Returns the value of the 'Suspension Trigger' containment reference.

If the meaning of the 'Suspension Trigger' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Suspension Trigger' containment reference.
See Also:
setSuspensionTrigger(Action), SyncchartsPackage.getScope_SuspensionTrigger()
Generated:
This code was automatically generated.
Model element:
containment=true

setSuspensionTrigger

void setSuspensionTrigger(Action value)
Sets the value of the 'Suspension Trigger' containment reference.

Parameters:
value - the new value of the 'Suspension Trigger' containment reference.
See Also:
getSuspensionTrigger()
Generated:
This code was automatically generated.

getExitActions

EList<Action> getExitActions()
Returns the value of the 'Exit Actions' containment reference list. The list contents are of type Action.

If the meaning of the 'Exit Actions' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Exit Actions' containment reference list.
See Also:
SyncchartsPackage.getScope_ExitActions()
Generated:
This code was automatically generated.
Model element:
containment=true

getInnerActions

EList<Action> getInnerActions()
Returns the value of the 'Inner Actions' containment reference list. The list contents are of type Action.

If the meaning of the 'Inner Actions' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Inner Actions' containment reference list.
See Also:
SyncchartsPackage.getScope_InnerActions()
Generated:
This code was automatically generated.
Model element:
containment=true

getEntryActions

EList<Action> getEntryActions()
Returns the value of the 'Entry Actions' containment reference list. The list contents are of type Action.

If the meaning of the 'Entry Actions' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Entry Actions' containment reference list.
See Also:
SyncchartsPackage.getScope_EntryActions()
Generated:
This code was automatically generated.
Model element:
containment=true

getBodyReference

EObject getBodyReference()
Returns the value of the 'Body Reference' reference.

If the meaning of the 'Body Reference' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Body Reference' reference.
See Also:
setBodyReference(EObject), SyncchartsPackage.getScope_BodyReference()
Generated:
This code was automatically generated.
Model element

setBodyReference

void setBodyReference(EObject value)
Sets the value of the 'Body Reference' reference.

Parameters:
value - the new value of the 'Body Reference' reference.
See Also:
getBodyReference()
Generated:
This code was automatically generated.

getBodyContents

EObject getBodyContents()
Returns the value of the 'Body Contents' containment reference.

If the meaning of the 'Body Contents' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Body Contents' containment reference.
See Also:
setBodyContents(EObject), SyncchartsPackage.getScope_BodyContents()
Generated:
This code was automatically generated.
Model element:
containment=true

setBodyContents

void setBodyContents(EObject value)
Sets the value of the 'Body Contents' containment reference.

Parameters:
value - the new value of the 'Body Contents' containment reference.
See Also:
getBodyContents()
Generated:
This code was automatically generated.

getBodyText

EList<TextualCode> getBodyText()
Returns the value of the 'Body Text' containment reference list. The list contents are of type TextualCode.

If the meaning of the 'Body Text' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Body Text' containment reference list.
See Also:
SyncchartsPackage.getScope_BodyText()
Generated:
This code was automatically generated.
Model element:
containment=true

getRenamings

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

Returns:
the value of the 'Renamings' containment reference list.
See Also:
SyncchartsPackage.getScope_Renamings(), Substitution.getParentScope()
Generated:
This code was automatically generated.
Model element:
opposite=parentScope
containment=true

getInterfaceDeclaration

String getInterfaceDeclaration()
Returns the value of the 'Interface Declaration' attribute.

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

Returns:
the value of the 'Interface Declaration' attribute.
See Also:
setInterfaceDeclaration(String), SyncchartsPackage.getScope_InterfaceDeclaration()
Generated:
This code was automatically generated.
Model element:
dataType=de.cau.cs.kieler.synccharts.Parsable

setInterfaceDeclaration

void setInterfaceDeclaration(String value)
Sets the value of the 'Interface Declaration' attribute.

Parameters:
value - the new value of the 'Interface Declaration' attribute.
See Also:
getInterfaceDeclaration()
Generated:
This code was automatically generated.