|
||||||||||
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:
Connection
Connection Point
Deferrable Trigger
Do Activity
Entry
Exit
Is Composite
Is Orthogonal
Is Simple
Is Submachine State
Redefined State
Region
State Invariant
Submachine
PivotPackage.getState()
Method Summary | |
---|---|
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 |
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 |
---|
getOwnedRule |
Methods inherited from interface org.eclipse.ocl.examples.pivot.NamedElement |
---|
getName, isStatic, setIsStatic, setName |
Methods inherited from interface org.eclipse.ocl.examples.pivot.Element |
---|
allOwnedElements, getETarget, getExtension, getOwnedAnnotation, 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.
PivotPackage.getState_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.
PivotPackage.getState_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.
PivotPackage.getState_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
.
It is bidirectional and its opposite is 'State
'.
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.getState()
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
.
It is bidirectional and its opposite is 'State
'.
The regions owned directly by the state.
PivotPackage.getState_Region()
,
Region.getState()
Constraint getStateInvariant()
Owning State
'.
Specifies conditions that are always true when this state is the current state. In protocol state machines, state invariants are additional conditions to the preconditions of the outgoing transitions, and to the postcondition of the incoming transitions.
setStateInvariant(Constraint)
,
PivotPackage.getState_StateInvariant()
,
Constraint.getOwningState()
void setStateInvariant(Constraint value)
State Invariant
' containment reference.
value
- the new value of the 'State Invariant' containment reference.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 getExit()
setExit(Behavior)
,
PivotPackage.getState_Exit()
void setExit(Behavior value)
Exit
' containment reference.
value
- the new value of the 'Exit' containment reference.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()
java.util.List<Pseudostate> getConnectionPoint()
Pseudostate
.
It is bidirectional and its opposite is 'State
'.
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.getState()
java.util.List<Trigger> getDeferrableTrigger()
Trigger
.
It is bidirectional and its opposite is 'State
'.
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.getState()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |