Package de.mid.innovator.srv2api.icw2sm

Interface SMVertex

All Superinterfaces:

ADClientAble, ADFindAble, ADHistoryAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAsgnAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

SMChoice, SMDeepHistory, SMEntryPoint, SMExitPoint, SMFinalState, SMInit, SMJoinFork, SMJunction, SMPseudoState, SMRegularState, SMShallowHistory, SMState, SMTerminator

public interface SMVertex
extends ADHistoryAble, ELNamespaceAble, MEConstraintAble, MEStereotypeAble, MECommentAble, MENamespaceAsgnAble, MMLabelTextAttachmentAble

A vertex is an abstraction of a node in a state machine graph. In general, it can be the source or destination of any number of transitions.

Note:

The interface SMVertex describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SMVertex.VAttr

Method Summary

Modifier and Type	Method	Description
java.util.List<SMTransExt>	getComesFromVertex(MMStereotype stereotype, SMVertex refObj, K_CONTROL_OPTION... behaviourFlags)	The method calls getComesFromVertex and filters its return values according to the given stereotype value.
java.util.List<SMTransExt>	getComesFromVertex(SMVertex refObj, K_CONTROL_OPTION... behaviourFlags)	All transitions which come from the state given by argument refObj to the state given state.
SMRegion	getContainer()	The region that contains this vertex.
java.util.List<SMTransExt>	getGoesToVertex(MMStereotype stereotype, SMVertex refObj, K_CONTROL_OPTION... behaviourFlags)	The method calls getGoesToVertex and filters its return values according to the given stereotype value.
java.util.List<SMTransExt>	getGoesToVertex(SMVertex refObj, K_CONTROL_OPTION... behaviourFlags)	All transitions which go from the given vertex to the vertex given by argument refObj.
java.util.List<SMTransExt>	getIncoming(K_CONTROL_OPTION... behaviourFlags)	The target vertex of the transition.
java.util.List<SMTransExt>	getOutgoing(K_CONTROL_OPTION... behaviourFlags)	The source vertex of the transition.
<T extends SMVertex> java.util.List<T>	getReachedVertex(java.lang.Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	All vertices which are reached transitive via transitions starting from the given vertex.
<T extends SMVertex> java.util.List<T>	getReachedVertex(java.lang.Class<T> returnType, MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)	The method calls getReachedVertex and filters its return values according to the given stereotype value.
boolean	isBetweenOrthogonalRegions(SMVertex refObj)	True, if an existing or possible transition which connects the given vertex and the vertex given by argument refObj is a transition between orthogonal regions.
boolean	isLeft()	True, if the given vertex is left direct or indirect by a transition.
boolean	isReached()	True, if the given vertex is reached.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRowList, getTabElementRowTypeList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble

getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble

delete

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELElement

duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble

getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAsgnAble

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject

getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELValueContainerAble

getValueReUseAble, setValueReUseAble

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MECommentAble

getAssignedComment, getAssignedComment, getCommentAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEConstraintAble

getAssignedConstraint, getAssignedConstraint, getConstraintAssign

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEModelElement

buildProxyConnection, getActivityPartition, getConsider, getContentStereotypeByClass, getCreateTemplateByClass, getElementColor, getFirstValidContentStereotype, getIgnore, getKnownTypeSystems, getMEModelName, getModelElement, getModelElement, getPresContext, getPresContext, getPresetMapping, getPRPresContent, setElementColor

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamedElement

getMappingSourceElement, getMappingSourceElement, getMESupplierDependency, getMESupplierMappingDependency

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MENamespaceAsgnAble

getMENamespace, getSignatureMessage

Methods inherited from interface de.mid.innovator.srv2api.icw2model.MEStereotypeAble

getApplicableAnalysisDia, getClientMappingDependency, getDecisionMade, getDecisionOwned, getKnowledgeSourceOfOwner, getMappingTargetElement, getMappingTargetElement, getProxyAsgProperty, getRepresentingArtifact, getRequirementOfStakeholder, getRequirementOfStakeholderOwner, isMapped, setMapped, setRequirementOfStakeholder

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMAttachmentAble

getAssignedAttachment, getAttachmentAssign, getDefaultAttachment, getOwnedAttachment, setDefaultAttachment

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMCommentContainerAble

getOutgoingConceptRealization, getOwnedComment, getRealizedConcept, getRealizedConcept, replaceRealizedConcepts, setRealizedConcept

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMLabelAble

getLabel, getLabelBoolValue, getLabelColor, getLabelInfo, getLabelLongValue, getLabelNameValue, getLabelStringValue, getLabelValueByPattern, getLabelValueByPattern, getLabelValueList, getOwnedLabelValSpec, hasLabel, modifyLabelValuesByName, setLabelInfo

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMStereotypeAble

assignStereotypeDlg, cloneElement, completelySynchronizeOthers, completelySynchronizeThis, getAttrCnstrEffective, getCreateTemplate, getDisplayType, getOwnedFormat, getOwnedStereotypePropertyValSpec, getOwnedStereotypeTSOptionValSpec, getOwnedSyncedElement, getPropBoolValue, getPropLongValue, getPropStringValue, getPropValueList, getStereoPropValueByPattern, getStereoPropValueByPattern, getStereotype, getStereotypeName, getStereotypeProperty, getStereotypePropertyInfo, getStereotypePropertyNameValue, getStereotypeTSOption, getStereotypeTSOptionBoolValue, getStereotypeTSOptionInfo, getStereotypeTSOptionLongValue, getStereotypeTSOptionNameValue, getStereotypeTSOptionStringValue, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueByPattern, getStereotypeTSOptionValueList, getSyncedElement, getSyncedStereotypeAble, getSyncedStereotypeAble, isCloneAbleElement, modifyStereotypePropertyValuesByName, modifyStereotypeTSOptionValuesByName, setStereotype, setStereotypePropertyInfo, setStereotypeTSOptionInfo, setSyncedStereotypeAble

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.MMTextAble

getFlowExpandedValue, getModifyFlowDocuments, getModifyTextValues, getModifyTextValuesDlgInit, getOwnedTextValue, getOwnedTextValueByPattern, getTextExpandedValue, getTextStringValue, getURIList, modifyFlowDocuments, modifyTextValuesDlg

Method Detail

isBetweenOrthogonalRegions

boolean isBetweenOrthogonalRegions(SMVertex refObj)
                            throws InoNetException,
                                   SrvErrorException

True, if an existing or possible transition which connects the given vertex and the vertex given by argument refObj is a transition between orthogonal regions.

Parameters:

refObj - A further instance of type SMVertex which is used to control the behaviour of the method. (see description above)

Throws:

InoNetException

SrvErrorException

isLeft

boolean isLeft()
        throws InoNetException,
               SrvErrorException

True, if the given vertex is left direct or indirect by a transition.

Throws:

InoNetException

SrvErrorException

isReached

boolean isReached()
           throws InoNetException,
                  SrvErrorException

True, if the given vertex is reached.

Throws:

InoNetException

SrvErrorException

getComesFromVertex

java.util.List<SMTransExt> getComesFromVertex(SMVertex refObj,
                                              K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException

All transitions which come from the state given by argument refObj to the state given state.

Parameters:

refObj - A further instance of type SMVertex which is used to control the behaviour of the method. (see description above)

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getComesFromVertex

java.util.List<SMTransExt> getComesFromVertex(MMStereotype stereotype,
                                              SMVertex refObj,
                                              K_CONTROL_OPTION... behaviourFlags)
                                       throws InoNetException,
                                              SrvErrorException

The method calls getComesFromVertex and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

refObj - A further instance of type SMVertex which is used to control the behaviour of the method. (see description above)

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getGoesToVertex

java.util.List<SMTransExt> getGoesToVertex(SMVertex refObj,
                                           K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

All transitions which go from the given vertex to the vertex given by argument refObj.

Parameters:

refObj - A further instance of type SMVertex which is used to control the behaviour of the method. (see description above)

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getGoesToVertex

java.util.List<SMTransExt> getGoesToVertex(MMStereotype stereotype,
                                           SMVertex refObj,
                                           K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

The method calls getGoesToVertex and filters its return values according to the given stereotype value.

Parameters:

stereotype - The stereotype used to filter the result list

refObj - A further instance of type SMVertex which is used to control the behaviour of the method. (see description above)

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getReachedVertex

<T extends SMVertex> java.util.List<T> getReachedVertex(java.lang.Class<T> returnType,
                                                        K_CONTROL_OPTION... behaviourFlags)
                                                 throws InoNetException,
                                                        SrvErrorException

All vertices which are reached transitive via transitions starting from the given vertex.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getReachedVertex

<T extends SMVertex> java.util.List<T> getReachedVertex(java.lang.Class<T> returnType,
                                                        MMStereotype stereotype,
                                                        K_CONTROL_OPTION... behaviourFlags)
                                                 throws InoNetException,
                                                        SrvErrorException

The method calls getReachedVertex and filters its return values according to the given stereotype value.

Parameters:

returnType - Specifies the type of elements to be returned.

stereotype - The stereotype used to filter the result list

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getIncoming

java.util.List<SMTransExt> getIncoming(K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
                                       SrvErrorException

The target vertex of the transition.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getOutgoing

java.util.List<SMTransExt> getOutgoing(K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
                                       SrvErrorException

The source vertex of the transition.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getContainer

SMRegion getContainer()
               throws InoNetException,
                      SrvErrorException

The region that contains this vertex.

Throws:

InoNetException

SrvErrorException