|
||||||||||
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 models a situation during which some (usually implicit) invariant condition holds.
The following features are supported:
Is Composite
Is Orthogonal
Is Simple
Is Submachine State
Submachine
Connection
Redefined State
Region
State Invariant
Entry
Exit
Do Activity
Connection Point
Deferrable Trigger
PivotPackage.getState()
Method Summary | |
---|---|
ConnectionPointReference |
createConnection()
Creates a new ConnectionPointReference and appends it to the 'Connection' containment reference list. |
Pseudostate |
createConnectionPoint()
Creates a new Pseudostate and appends it to the 'Connection Point' containment reference list. |
Trigger |
createDeferrableTrigger()
Creates a new Trigger and appends it to the 'Deferrable Trigger' containment reference list. |
Behavior |
createDoActivity()
Creates a new StateMachine and sets the 'Do Activity' containment reference. |
Behavior |
createDoActivity(org.eclipse.emf.ecore.EClass eClass)
Creates a new Behavior and sets the 'Do Activity' containment reference. |
Behavior |
createEntry()
Creates a new StateMachine and sets the 'Entry' containment reference. |
Behavior |
createEntry(org.eclipse.emf.ecore.EClass eClass)
Creates a new Behavior and sets the 'Entry' containment reference. |
Behavior |
createExit()
Creates a new StateMachine and sets the 'Exit' containment reference. |
Behavior |
createExit(org.eclipse.emf.ecore.EClass eClass)
Creates a new Behavior and sets the 'Exit' containment reference. |
Region |
createRegion()
Creates a new Region and appends it to the 'Region' containment reference list. |
Constraint |
createStateInvariant()
Creates a new Constraint and sets the 'State Invariant' containment reference. |
java.util.List<ConnectionPointReference> |
getConnection()
Returns the value of the 'Connection' containment reference list. |
java.util.List<Pseudostate> |
getConnectionPoint()
Returns the value of the 'Connection Point' containment reference list. |
java.util.List<Trigger> |
getDeferrableTrigger()
Returns the value of the 'Deferrable Trigger' containment reference list. |
Behavior |
getDoActivity()
Returns the value of the 'Do Activity' containment reference. |
Behavior |
getEntry()
Returns the value of the 'Entry' containment reference. |
Behavior |
getExit()
Returns the value of the 'Exit' containment reference. |
State |
getRedefinedState()
Returns the value of the 'Redefined State' reference. |
java.util.List<Region> |
getRegion()
Returns the value of the 'Region' containment reference list. |
Constraint |
getStateInvariant()
Returns the value of the 'State Invariant' containment reference. |
StateMachine |
getSubmachine()
Returns the value of the 'Submachine' reference. |
boolean |
isComposite()
Returns the value of the 'Is Composite' attribute. |
boolean |
isOrthogonal()
Returns the value of the 'Is Orthogonal' attribute. |
boolean |
isSimple()
Returns the value of the 'Is Simple' attribute. |
boolean |
isSubmachineState()
Returns the value of the 'Is Submachine State' attribute. |
void |
setDoActivity(Behavior value)
Sets the value of the ' Do Activity ' containment reference. |
void |
setEntry(Behavior value)
Sets the value of the ' Entry ' containment reference. |
void |
setExit(Behavior value)
Sets the value of the ' Exit ' containment reference. |
void |
setIsComposite(boolean value)
Sets the value of the ' Is Composite ' attribute. |
void |
setIsOrthogonal(boolean value)
Sets the value of the ' Is Orthogonal ' attribute. |
void |
setIsSimple(boolean value)
Sets the value of the ' Is Simple ' attribute. |
void |
setIsSubmachineState(boolean value)
Sets the value of the ' Is Submachine State ' attribute. |
void |
setRedefinedState(State value)
Sets the value of the ' Redefined State ' reference. |
void |
setStateInvariant(Constraint value)
Sets the value of the ' State Invariant ' containment reference. |
void |
setSubmachine(StateMachine value)
Sets the value of the ' Submachine ' reference. |
Methods inherited from interface org.eclipse.ocl.examples.pivot.Vertex |
---|
getContainer, getIncoming, getOutgoing, setContainer |
Methods inherited from interface org.eclipse.ocl.examples.pivot.Namespace |
---|
createOwnedRule, getOwnedRule |
Methods inherited from interface org.eclipse.ocl.examples.pivot.NamedElement |
---|
createOwnedAnnotation, getName, getOwnedAnnotation, isStatic, setIsStatic, setName |
Methods inherited from interface org.eclipse.ocl.examples.pivot.Element |
---|
allOwnedElements, createExtension, createOwnedComment, getETarget, getExtension, getOwnedComment, getValue |
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 |
Methods inherited from interface org.eclipse.ocl.examples.pivot.util.Visitable |
---|
accept, eClass |
Method Detail |
---|
boolean isComposite()
"false"
.
A state with isComposite=true is said to be a composite state. A composite state is a state that contains at least one region.
setIsComposite(boolean)
,
PivotPackage.getState_IsComposite()
void setIsComposite(boolean value)
Is Composite
' attribute.
value
- the new value of the 'Is Composite' attribute.isComposite()
boolean isOrthogonal()
"false"
.
A state with isOrthogonal=true is said to be an orthogonal composite state. An orthogonal composite state contains two or more regions.
setIsOrthogonal(boolean)
,
PivotPackage.getState_IsOrthogonal()
void setIsOrthogonal(boolean value)
Is Orthogonal
' attribute.
value
- the new value of the 'Is Orthogonal' attribute.isOrthogonal()
boolean isSimple()
"true"
.
A state with isSimple=true is said to be a simple state. A simple state does not have any regions and it does not refer to any submachine state machine.
setIsSimple(boolean)
,
PivotPackage.getState_IsSimple()
void setIsSimple(boolean value)
Is Simple
' attribute.
value
- the new value of the 'Is Simple' attribute.isSimple()
boolean isSubmachineState()
"false"
.
A state with isSubmachineState=true is said to be a submachine state. Such a state refers to a state machine (submachine).
setIsSubmachineState(boolean)
,
PivotPackage.getState_IsSubmachineState()
void setIsSubmachineState(boolean value)
Is Submachine State
' attribute.
value
- the new value of the 'Is Submachine State' attribute.isSubmachineState()
StateMachine getSubmachine()
Submachine State
'.
The state machine that is to be inserted in place of the (submachine) state.
setSubmachine(StateMachine)
,
PivotPackage.getState_Submachine()
,
StateMachine.getSubmachineState()
void setSubmachine(StateMachine value)
Submachine
' reference.
value
- the new value of the 'Submachine' reference.getSubmachine()
java.util.List<ConnectionPointReference> getConnection()
ConnectionPointReference
.
The entry and exit connection points used in conjunction with this (submachine) state, i.e. as targets and sources, respectively, in the region with the submachine state. A connection point reference references the corresponding definition of a connection point pseudostate in the statemachine referenced by the submachinestate.
PivotPackage.getState_Connection()
ConnectionPointReference createConnection()
ConnectionPointReference
and appends it to the 'Connection' containment reference list.
ConnectionPointReference
.getConnection()
State getRedefinedState()
setRedefinedState(State)
,
PivotPackage.getState_RedefinedState()
void setRedefinedState(State value)
Redefined State
' reference.
value
- the new value of the 'Redefined State' reference.getRedefinedState()
java.util.List<Region> getRegion()
Region
.
The regions owned directly by the state.
PivotPackage.getState_Region()
Region createRegion()
Region
and appends it to the 'Region' containment reference list.
Region
.getRegion()
Constraint getStateInvariant()
setStateInvariant(Constraint)
,
PivotPackage.getState_StateInvariant()
void setStateInvariant(Constraint value)
State Invariant
' containment reference.
value
- the new value of the 'State Invariant' containment reference.getStateInvariant()
Constraint createStateInvariant()
Constraint
and sets the 'State Invariant' containment reference.
Constraint
.getStateInvariant()
Behavior getEntry()
setEntry(Behavior)
,
PivotPackage.getState_Entry()
void setEntry(Behavior value)
Entry
' containment reference.
value
- the new value of the 'Entry' containment reference.getEntry()
Behavior createEntry(org.eclipse.emf.ecore.EClass eClass)
Behavior
and sets the 'Entry' containment reference.
eClass
- The Ecore class of the Behavior
to create.
Behavior
.getEntry()
Behavior createEntry()
StateMachine
and sets the 'Entry' containment reference.
StateMachine
.getEntry()
Behavior getExit()
setExit(Behavior)
,
PivotPackage.getState_Exit()
void setExit(Behavior value)
Exit
' containment reference.
value
- the new value of the 'Exit' containment reference.getExit()
Behavior createExit(org.eclipse.emf.ecore.EClass eClass)
Behavior
and sets the 'Exit' containment reference.
eClass
- The Ecore class of the Behavior
to create.
Behavior
.getExit()
Behavior createExit()
StateMachine
and sets the 'Exit' containment reference.
StateMachine
.getExit()
Behavior getDoActivity()
setDoActivity(Behavior)
,
PivotPackage.getState_DoActivity()
void setDoActivity(Behavior value)
Do Activity
' containment reference.
value
- the new value of the 'Do Activity' containment reference.getDoActivity()
Behavior createDoActivity(org.eclipse.emf.ecore.EClass eClass)
Behavior
and sets the 'Do Activity' containment reference.
eClass
- The Ecore class of the Behavior
to create.
Behavior
.getDoActivity()
Behavior createDoActivity()
StateMachine
and sets the 'Do Activity' containment reference.
StateMachine
.getDoActivity()
java.util.List<Pseudostate> getConnectionPoint()
Pseudostate
.
The entry and exit pseudostates of a composite state. These can only be entry or exit Pseudostates, and they must have different names. They can only be defined for composite states.
PivotPackage.getState_ConnectionPoint()
Pseudostate createConnectionPoint()
Pseudostate
and appends it to the 'Connection Point' containment reference list.
Pseudostate
.getConnectionPoint()
java.util.List<Trigger> getDeferrableTrigger()
Trigger
.
A list of triggers that are candidates to be retained by the state machine if they trigger no transitions out of the state (not consumed). A deferred trigger is retained until the state machine reaches a state configuration where it is no longer deferred.
PivotPackage.getState_DeferrableTrigger()
Trigger createDeferrableTrigger()
Trigger
and appends it to the 'Deferrable Trigger' containment reference list.
Trigger
.getDeferrableTrigger()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |