org.eclipse.ocl.examples.pivot
Interface Transition

All Superinterfaces:

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

All Known Implementing Classes:

TransitionImpl

public interface Transition
extends Namespace

A representation of the model object 'Transition'. A transition is a directed relationship between a source vertex and a target vertex. It may be part of a compound transition, which takes the state machine from one state configuration to another, representing the complete response of the state machine to an occurrence of an event of a particular type.

The following features are supported:

• Kind
• Source
• Target
• Guard
• Effect
• Trigger
• Container

See Also:

PivotPackage.getTransition()

Generated

Method Summary

Behavior	createEffect() Creates a new StateMachine and sets the 'Effect' containment reference.
Behavior	createEffect(org.eclipse.emf.ecore.EClass eClass) Creates a new Behavior and sets the 'Effect' containment reference.
Constraint	createGuard() Creates a new Constraint and sets the 'Guard' containment reference.
Trigger	createTrigger() Creates a new Trigger and appends it to the 'Trigger' containment reference list.
Region	getContainer() Returns the value of the 'Container' container reference.
Behavior	getEffect() Returns the value of the 'Effect' containment reference.
Constraint	getGuard() Returns the value of the 'Guard' containment reference.
TransitionKind	getKind() Returns the value of the 'Kind' attribute.
Vertex	getSource() Returns the value of the 'Source' reference.
Vertex	getTarget() Returns the value of the 'Target' reference.
java.util.List<Trigger>	getTrigger() Returns the value of the 'Trigger' containment reference list.
void	setContainer(Region value) Sets the value of the 'Container' container reference.
void	setEffect(Behavior value) Sets the value of the 'Effect' containment reference.
void	setGuard(Constraint value) Sets the value of the 'Guard' containment reference.
void	setKind(TransitionKind value) Sets the value of the 'Kind' attribute.
void	setSource(Vertex value) Sets the value of the 'Source' reference.
void	setTarget(Vertex value) Sets the value of the 'Target' reference.

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

getKind

TransitionKind getKind()

Returns the value of the 'Kind' attribute. The default value is "external". The literals are from the enumeration TransitionKind. Indicates the precise type of the transition.

Returns:

the value of the 'Kind' attribute.

See Also:

TransitionKind, setKind(TransitionKind), PivotPackage.getTransition_Kind()

Generated

setKind

void setKind(TransitionKind value)

Sets the value of the 'Kind' attribute.

Parameters:

value - the new value of the 'Kind' attribute.

See Also:

TransitionKind, getKind()

Generated

getContainer

Region getContainer()

Returns the value of the 'Container' container reference. It is bidirectional and its opposite is 'Transition'. Designates the region that owns this transition.

Returns:

the value of the 'Container' container reference.

See Also:

setContainer(Region), PivotPackage.getTransition_Container(), Region.getTransition()

Generated

setContainer

void setContainer(Region value)

Sets the value of the 'Container' container reference.

Parameters:

value - the new value of the 'Container' container reference.

See Also:

getContainer()

Generated

getSource

Vertex getSource()

Returns the value of the 'Source' reference. It is bidirectional and its opposite is 'Outgoing'. Designates the originating vertex (state or pseudostate) of the transition.

Returns:

the value of the 'Source' reference.

See Also:

setSource(Vertex), PivotPackage.getTransition_Source(), Vertex.getOutgoing()

Generated

setSource

void setSource(Vertex value)

Sets the value of the 'Source' reference.

Parameters:

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

See Also:

getSource()

Generated

getTarget

Vertex getTarget()

Returns the value of the 'Target' reference. It is bidirectional and its opposite is 'Incoming'. Designates the target vertex that is reached when the transition is taken.

Returns:

the value of the 'Target' reference.

See Also:

setTarget(Vertex), PivotPackage.getTransition_Target(), Vertex.getIncoming()

Generated

setTarget

void setTarget(Vertex value)

Sets the value of the 'Target' reference.

Parameters:

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

See Also:

getTarget()

Generated

getGuard

Constraint getGuard()

Returns the value of the 'Guard' containment reference. A guard is a constraint that provides a fine-grained control over the firing of the transition. The guard is evaluated when an event occurrence is dispatched by the state machine. If the guard is true at that time, the transition may be enabled, otherwise, it is disabled. Guards should be pure expressions without side effects. Guard expressions with side effects are ill formed.

Returns:

the value of the 'Guard' containment reference.

See Also:

setGuard(Constraint), PivotPackage.getTransition_Guard()

Generated

setGuard

void setGuard(Constraint value)

Sets the value of the 'Guard' containment reference.

Parameters:

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

See Also:

getGuard()

Generated

createGuard

Constraint createGuard()

Creates a new Constraint and sets the 'Guard' containment reference.

Returns:

The new Constraint.

See Also:

getGuard()

Generated

getEffect

Behavior getEffect()

Returns the value of the 'Effect' containment reference. Specifies an optional behavior to be performed when the transition fires.

Returns:

the value of the 'Effect' containment reference.

See Also:

setEffect(Behavior), PivotPackage.getTransition_Effect()

Generated

setEffect

void setEffect(Behavior value)

Sets the value of the 'Effect' containment reference.

Parameters:

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

See Also:

getEffect()

Generated

createEffect

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

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

Parameters:

eClass - The Ecore class of the Behavior to create.

Returns:

The new Behavior.

See Also:

getEffect()

Generated

createEffect

Behavior createEffect()

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

Returns:

The new StateMachine.

See Also:

getEffect()

Generated

getTrigger

java.util.List<Trigger> getTrigger()

Returns the value of the 'Trigger' containment reference list. The list contents are of type Trigger. Specifies the triggers that may fire the transition.

Returns:

the value of the 'Trigger' containment reference list.

See Also:

PivotPackage.getTransition_Trigger()

Generated

createTrigger

Trigger createTrigger()

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

Returns:

The new Trigger.

See Also:

getTrigger()

Generated