org.eclipse.uml2.uml

Interface Pseudostate

All Superinterfaces:

Element, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.EObject, NamedElement, org.eclipse.emf.common.notify.Notifier, Vertex

public interface Pseudostate
extends Vertex

A representation of the model object 'Pseudostate'. A Pseudostate is an abstraction that encompasses different types of transient Vertices in the StateMachine graph. A StateMachine instance never comes to rest in a Pseudostate, instead, it will exit and enter the Pseudostate within a single run-to-completion step.

From package UML::StateMachines.

The following features are supported:

• State
• Kind
• State Machine

See Also:

UMLPackage.getPseudostate()

Field Summary

Fields inherited from interface org.eclipse.uml2.uml.NamedElement

SEPARATOR

Method Summary

Modifier and Type	Method and Description
PseudostateKind	getKind() Returns the value of the 'Kind' attribute.
State	getState() Returns the value of the 'State' container reference.
StateMachine	getStateMachine() Returns the value of the 'State Machine' container reference.
void	setKind(PseudostateKind value) Sets the value of the 'Kind' attribute
void	setState(State value) Sets the value of the 'State' container reference
void	setStateMachine(StateMachine value) Sets the value of the 'State Machine' container reference
boolean	validateChoiceVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) In a complete statemachine, a choice Vertex must have at least one incoming and one outgoing Transition.
boolean	validateForkVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) In a complete StateMachine, a fork Vertex must have at least two outgoing Transitions and exactly one incoming Transition.
boolean	validateHistoryVertices(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) History Vertices can have at most one outgoing Transition.
boolean	validateInitialVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) An initial Vertex can have at most one outgoing Transition.
boolean	validateJoinVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) In a complete StateMachine, a join Vertex must have at least two incoming Transitions and exactly one outgoing Transition.
boolean	validateJunctionVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) In a complete StateMachine, a junction Vertex must have at least one incoming and one outgoing Transition.
boolean	validateOutgoingFromInitial(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) The outgoing Transition from an initial vertex may have a behavior, but not a trigger or a guard.
boolean	validateTransitionsIncoming(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) All Transitions incoming a join Vertex must originate in different Regions of an orthogonal State.
boolean	validateTransitionsOutgoing(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) All transitions outgoing a fork vertex must target states in different regions of an orthogonal state.

Methods inherited from interface org.eclipse.uml2.uml.Vertex

containingStateMachine, getContainer, getIncoming, getIncoming, getIncomings, getOutgoing, getOutgoing, getOutgoings, isContainedInRegion, isContainedInState, setContainer

Methods inherited from interface org.eclipse.uml2.uml.NamedElement

allNamespaces, allOwningPackages, createDependency, createNameExpression, createUsage, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership

Methods inherited from interface org.eclipse.uml2.uml.Element

addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, validateHasOwner, validateNotOwnSelf

Methods inherited from interface org.eclipse.emf.ecore.EModelElement

getEAnnotation, getEAnnotations

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

Method Detail

getKind

PseudostateKind getKind()

Returns the value of the 'Kind' attribute. The default value is "initial". The literals are from the enumeration PseudostateKind. Determines the precise type of the Pseudostate and can be one of: entryPoint, exitPoint, initial, deepHistory, shallowHistory, join, fork, junction, terminate or choice.

From package UML::StateMachines.

Returns:

the value of the 'Kind' attribute.

See Also:

PseudostateKind, setKind(PseudostateKind), UMLPackage.getPseudostate_Kind()

setKind

void setKind(PseudostateKind value)

Sets the value of the 'Kind' attribute.

Parameters:

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

See Also:

PseudostateKind, getKind()

getStateMachine

StateMachine getStateMachine()

Returns the value of the 'State Machine' container reference. It is bidirectional and its opposite is 'Connection Point'.

This feature subsets the following features:

• 'Namespace'

The StateMachine in which this Pseudostate is defined. This only applies to Pseudostates of the kind entryPoint or exitPoint.

From package UML::StateMachines.

Returns:

the value of the 'State Machine' container reference.

See Also:

setStateMachine(StateMachine), UMLPackage.getPseudostate_StateMachine(), StateMachine.getConnectionPoints()

setStateMachine

void setStateMachine(StateMachine value)

Sets the value of the 'State Machine' container reference.

Parameters:

value - the new value of the 'State Machine' container reference.

See Also:

getStateMachine()

getState

State getState()

Returns the value of the 'State' container reference. It is bidirectional and its opposite is 'Connection Point'.

This feature subsets the following features:

• 'Namespace'

The State that owns this Pseudostate and in which it appears.

From package UML::StateMachines.

Returns:

the value of the 'State' container reference.

See Also:

setState(State), UMLPackage.getPseudostate_State(), State.getConnectionPoints()

setState

void setState(State value)

Sets the value of the 'State' container reference.

Parameters:

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

See Also:

getState()

validateInitialVertex

boolean validateInitialVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                              java.util.Map<java.lang.Object,java.lang.Object> context)

An initial Vertex can have at most one outgoing Transition. (kind = PseudostateKind::initial) implies (outgoing->size() <= 1)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateHistoryVertices

boolean validateHistoryVertices(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                java.util.Map<java.lang.Object,java.lang.Object> context)

History Vertices can have at most one outgoing Transition. ((kind = PseudostateKind::deepHistory) or (kind = PseudostateKind::shallowHistory)) implies (outgoing->size() <= 1)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateJoinVertex

boolean validateJoinVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                           java.util.Map<java.lang.Object,java.lang.Object> context)

In a complete StateMachine, a join Vertex must have at least two incoming Transitions and exactly one outgoing Transition. (kind = PseudostateKind::join) implies (outgoing->size() = 1 and incoming->size() >= 2)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateTransitionsIncoming

boolean validateTransitionsIncoming(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                    java.util.Map<java.lang.Object,java.lang.Object> context)

All Transitions incoming a join Vertex must originate in different Regions of an orthogonal State. (kind = PseudostateKind::join) implies -- for any pair of incoming transitions there exists an orthogonal state which contains the source vetices of these transitions -- such that these source vertices belong to different regions of that orthogonal state incoming->forAll(t1:Transition, t2:Transition | let contState:State = containingStateMachine().LCAState(t1.source, t2.source) in ((contState <> null) and (contState.region ->exists(r1:Region, r2: Region | (r1 <> r2) and t1.source.isContainedInRegion(r1) and t2.source.isContainedInRegion(r2)))))

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateForkVertex

boolean validateForkVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                           java.util.Map<java.lang.Object,java.lang.Object> context)

In a complete StateMachine, a fork Vertex must have at least two outgoing Transitions and exactly one incoming Transition. (kind = PseudostateKind::fork) implies (incoming->size() = 1 and outgoing->size() >= 2)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateTransitionsOutgoing

boolean validateTransitionsOutgoing(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                    java.util.Map<java.lang.Object,java.lang.Object> context)

All transitions outgoing a fork vertex must target states in different regions of an orthogonal state. (kind = PseudostateKind::fork) implies -- for any pair of outgoing transitions there exists an orthogonal state which contains the targets of these transitions -- such that these targets belong to different regions of that orthogonal state outgoing->forAll(t1:Transition, t2:Transition | let contState:State = containingStateMachine().LCAState(t1.target, t2.target) in ((contState <> null) and (contState.region ->exists(r1:Region, r2: Region | (r1 <> r2) and t1.target.isContainedInRegion(r1) and t2.target.isContainedInRegion(r2)))))

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateJunctionVertex

boolean validateJunctionVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                               java.util.Map<java.lang.Object,java.lang.Object> context)

In a complete StateMachine, a junction Vertex must have at least one incoming and one outgoing Transition. (kind = PseudostateKind::junction) implies (incoming->size() >= 1 and outgoing->size() >= 1)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateChoiceVertex

boolean validateChoiceVertex(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                             java.util.Map<java.lang.Object,java.lang.Object> context)

In a complete statemachine, a choice Vertex must have at least one incoming and one outgoing Transition. (kind = PseudostateKind::choice) implies (incoming->size() >= 1 and outgoing->size() >= 1)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

validateOutgoingFromInitial

boolean validateOutgoingFromInitial(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                    java.util.Map<java.lang.Object,java.lang.Object> context)

The outgoing Transition from an initial vertex may have a behavior, but not a trigger or a guard. (kind = PseudostateKind::initial) implies (outgoing.guard = null and outgoing.trigger->isEmpty())

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.