org.eclipse.ocl.examples.pivot
Interface State

All Superinterfaces:

DomainElement, DomainNamedElement, DomainNamespace, Element, org.eclipse.emf.ecore.EObject, Nameable, NamedElement, Namespace, org.eclipse.emf.common.notify.Notifier, PivotObject, Vertex, Visitable

All Known Subinterfaces:

FinalState

All Known Implementing Classes:

FinalStateImpl, StateImpl

public interface State
extends Vertex, Namespace

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

See Also:

PivotPackage.getState()

Generated

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

isComposite

boolean isComposite()

Returns the value of the 'Is Composite' attribute. The default value is "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.

Returns:

the value of the 'Is Composite' attribute.

See Also:

setIsComposite(boolean), PivotPackage.getState_IsComposite()

Generated

setIsComposite

void setIsComposite(boolean value)

Sets the value of the 'Is Composite' attribute.

Parameters:

value - the new value of the 'Is Composite' attribute.

See Also:

isComposite()

Generated

isOrthogonal

boolean isOrthogonal()

Returns the value of the 'Is Orthogonal' attribute. The default value is "false". A state with isOrthogonal=true is said to be an orthogonal composite state. An orthogonal composite state contains two or more regions.

Returns:

the value of the 'Is Orthogonal' attribute.

See Also:

setIsOrthogonal(boolean), PivotPackage.getState_IsOrthogonal()

Generated

setIsOrthogonal

void setIsOrthogonal(boolean value)

Sets the value of the 'Is Orthogonal' attribute.

Parameters:

value - the new value of the 'Is Orthogonal' attribute.

See Also:

isOrthogonal()

Generated

isSimple

boolean isSimple()

Returns the value of the 'Is Simple' attribute. The default value is "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.

Returns:

the value of the 'Is Simple' attribute.

See Also:

setIsSimple(boolean), PivotPackage.getState_IsSimple()

Generated

setIsSimple

void setIsSimple(boolean value)

Sets the value of the 'Is Simple' attribute.

Parameters:

value - the new value of the 'Is Simple' attribute.

See Also:

isSimple()

Generated

isSubmachineState

boolean isSubmachineState()

Returns the value of the 'Is Submachine State' attribute. The default value is "false". A state with isSubmachineState=true is said to be a submachine state. Such a state refers to a state machine (submachine).

Returns:

the value of the 'Is Submachine State' attribute.

See Also:

setIsSubmachineState(boolean), PivotPackage.getState_IsSubmachineState()

Generated

setIsSubmachineState

void setIsSubmachineState(boolean value)

Sets the value of the 'Is Submachine State' attribute.

Parameters:

value - the new value of the 'Is Submachine State' attribute.

See Also:

isSubmachineState()

Generated

getSubmachine

StateMachine getSubmachine()

Returns the value of the 'Submachine' reference. It is bidirectional and its opposite is 'Submachine State'. The state machine that is to be inserted in place of the (submachine) state.

Returns:

the value of the 'Submachine' reference.

See Also:

setSubmachine(StateMachine), PivotPackage.getState_Submachine(), StateMachine.getSubmachineState()

Generated

setSubmachine

void setSubmachine(StateMachine value)

Sets the value of the 'Submachine' reference.

Parameters:

value - the new value of the 'Submachine' reference.

See Also:

getSubmachine()

Generated

getConnection

java.util.List<ConnectionPointReference> getConnection()

Returns the value of the 'Connection' containment reference list. The list contents are of type 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.

Returns:

the value of the 'Connection' containment reference list.

See Also:

PivotPackage.getState_Connection()

Generated

createConnection

ConnectionPointReference createConnection()

Creates a new ConnectionPointReference and appends it to the 'Connection' containment reference list.

Returns:

The new ConnectionPointReference.

See Also:

getConnection()

Generated

getRedefinedState

State getRedefinedState()

Returns the value of the 'Redefined State' reference. The state of which this state is a redefinition.

Returns:

the value of the 'Redefined State' reference.

See Also:

setRedefinedState(State), PivotPackage.getState_RedefinedState()

Generated

setRedefinedState

void setRedefinedState(State value)

Sets the value of the 'Redefined State' reference.

Parameters:

value - the new value of the 'Redefined State' reference.

See Also:

getRedefinedState()

Generated

getRegion

java.util.List<Region> getRegion()

Returns the value of the 'Region' containment reference list. The list contents are of type Region. The regions owned directly by the state.

Returns:

the value of the 'Region' containment reference list.

See Also:

PivotPackage.getState_Region()

Generated

createRegion

Region createRegion()

Creates a new Region and appends it to the 'Region' containment reference list.

Returns:

The new Region.

See Also:

getRegion()

Generated

getStateInvariant

Constraint getStateInvariant()

Returns the value of the 'State Invariant' containment reference. 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.

Returns:

the value of the 'State Invariant' containment reference.

See Also:

setStateInvariant(Constraint), PivotPackage.getState_StateInvariant()

Generated

setStateInvariant

void setStateInvariant(Constraint value)

Sets the value of the 'State Invariant' containment reference.

Parameters:

value - the new value of the 'State Invariant' containment reference.

See Also:

getStateInvariant()

Generated

createStateInvariant

Constraint createStateInvariant()

Creates a new Constraint and sets the 'State Invariant' containment reference.

Returns:

The new Constraint.

See Also:

getStateInvariant()

Generated

getEntry

Behavior getEntry()

Returns the value of the 'Entry' containment reference. An optional behavior that is executed whenever this state is entered regardless of the transition taken to reach the state. If defined, entry actions are always executed to completion prior to any internal behavior or transitions performed within the state.

Returns:

the value of the 'Entry' containment reference.

See Also:

setEntry(Behavior), PivotPackage.getState_Entry()

Generated

setEntry

void setEntry(Behavior value)

Sets the value of the 'Entry' containment reference.

Parameters:

value - the new value of the 'Entry' containment reference.

See Also:

getEntry()

Generated

createEntry

Behavior createEntry(org.eclipse.emf.ecore.EClass eClass)

Creates a new Behavior and sets the 'Entry' containment reference.

Parameters:

eClass - The Ecore class of the Behavior to create.

Returns:

The new Behavior.

See Also:

getEntry()

Generated

createEntry

Behavior createEntry()

Creates a new StateMachine and sets the 'Entry' containment reference.

Returns:

The new StateMachine.

See Also:

getEntry()

Generated

getExit

Behavior getExit()

Returns the value of the 'Exit' containment reference. An optional behavior that is executed whenever this state is exited regardless of which transition was taken out of the state. If defined, exit actions are always executed to completion only after all internal activities and transition actions have completed execution.

Returns:

the value of the 'Exit' containment reference.

See Also:

setExit(Behavior), PivotPackage.getState_Exit()

Generated

setExit

void setExit(Behavior value)

Sets the value of the 'Exit' containment reference.

Parameters:

value - the new value of the 'Exit' containment reference.

See Also:

getExit()

Generated

createExit

Behavior createExit(org.eclipse.emf.ecore.EClass eClass)

Creates a new Behavior and sets the 'Exit' containment reference.

Parameters:

eClass - The Ecore class of the Behavior to create.

Returns:

The new Behavior.

See Also:

getExit()

Generated

createExit

Behavior createExit()

Creates a new StateMachine and sets the 'Exit' containment reference.

Returns:

The new StateMachine.

See Also:

getExit()

Generated

getDoActivity

Behavior getDoActivity()

Returns the value of the 'Do Activity' containment reference. An optional behavior that is executed while being in the state. The execution starts when this state is entered, and stops either by itself, or when the state is exited, whichever comes first.

Returns:

the value of the 'Do Activity' containment reference.

See Also:

setDoActivity(Behavior), PivotPackage.getState_DoActivity()

Generated

setDoActivity

void setDoActivity(Behavior value)

Sets the value of the 'Do Activity' containment reference.

Parameters:

value - the new value of the 'Do Activity' containment reference.

See Also:

getDoActivity()

Generated

createDoActivity

Behavior createDoActivity(org.eclipse.emf.ecore.EClass eClass)

Creates a new Behavior and sets the 'Do Activity' containment reference.

Parameters:

eClass - The Ecore class of the Behavior to create.

Returns:

The new Behavior.

See Also:

getDoActivity()

Generated

createDoActivity

Behavior createDoActivity()

Creates a new StateMachine and sets the 'Do Activity' containment reference.

Returns:

The new StateMachine.

See Also:

getDoActivity()

Generated

getConnectionPoint

java.util.List<Pseudostate> getConnectionPoint()

Returns the value of the 'Connection Point' containment reference list. The list contents are of type 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.

Returns:

the value of the 'Connection Point' containment reference list.

See Also:

PivotPackage.getState_ConnectionPoint()

Generated

createConnectionPoint

Pseudostate createConnectionPoint()

Creates a new Pseudostate and appends it to the 'Connection Point' containment reference list.

Returns:

The new Pseudostate.

See Also:

getConnectionPoint()

Generated

getDeferrableTrigger

java.util.List<Trigger> getDeferrableTrigger()

Returns the value of the 'Deferrable Trigger' containment reference list. The list contents are of type 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.

Returns:

the value of the 'Deferrable Trigger' containment reference list.

See Also:

PivotPackage.getState_DeferrableTrigger()

Generated

createDeferrableTrigger

Trigger createDeferrableTrigger()

Creates a new Trigger and appends it to the 'Deferrable Trigger' containment reference list.

Returns:

The new Trigger.

See Also:

getDeferrableTrigger()

Generated