Package com.nomagic.uml2.ext.magicdraw.activities.mdstructuredactivities

Interface LoopNode

All Superinterfaces:

Action, ActivityGroup, ActivityNode, BaseElement, java.lang.Cloneable, java.lang.Comparable, Element, org.eclipse.emf.ecore.EObject, ExecutableNode, MDObject, ModelObject, NamedElement, Namespace, org.eclipse.emf.common.notify.Notifier, RedefinableElement, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, StructuredActivityNode

public interface LoopNode
extends StructuredActivityNode

A representation of the model object 'Loop Node'.

A LoopNode is a StructuredActivityNode that represents an iterative loop with setup, test, and body sections.

The following features are supported:

• Body Output
• Body Part
• Decider
• Tested First
• Loop Variable Input
• Result
• Setup Part
• Test
• Loop Variable

See Also:

UMLPackage.getLoopNode()

Model:

annotation="MOF package='activities.mdstructuredactivities'"

Generated:

Method Summary

Modifier and Type	Method	Description
java.util.List<OutputPin>	getBodyOutput()	Returns the value of the 'Body Output' reference list.
java.util.Collection<ExecutableNode>	getBodyPart()	Returns the value of the 'Body Part' reference list.
OutputPin	getDecider()	Returns the value of the 'Decider' reference.
java.util.List<OutputPin>	getLoopVariable()	Returns the value of the 'Loop Variable' containment reference list.
java.util.List<InputPin>	getLoopVariableInput()	Returns the value of the 'Loop Variable Input' containment reference list.
java.util.List<OutputPin>	getResult()	Returns the value of the 'Result' containment reference list.
java.util.Collection<ExecutableNode>	getSetupPart()	Returns the value of the 'Setup Part' reference list.
java.util.Collection<ExecutableNode>	getTest()	Returns the value of the 'Test' reference list.
boolean	hasBodyOutput()
boolean	hasBodyPart()
boolean	hasLoopVariable()
boolean	hasLoopVariableInput()
boolean	hasResult()
boolean	hasSetupPart()
boolean	hasTest()
boolean	isTestedFirst()	Returns the value of the 'Tested First' attribute.
void	setDecider(OutputPin value)	Sets the value of the 'Decider' reference.
void	setTestedFirst(boolean value)	Sets the value of the 'Tested First' attribute.

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.actions.mdbasicactions.Action

get_actionExecutionSpecificationOfAction, get_actionInputPinOfFromAction, get_interactionOfAction, getContext, getInput, getLocalPostcondition, getLocalPrecondition, getOutput, has_actionExecutionSpecificationOfAction, hasInput, hasLocalPostcondition, hasLocalPrecondition, hasOutput, isLocallyReentrant, set_actionInputPinOfFromAction, set_interactionOfAction, setLocallyReentrant

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.activities.mdfundamentalactivities.ActivityGroup

getContainedEdge, getContainedNode, getInActivity, getSubgroup, getSuperGroup, hasContainedEdge, hasContainedNode, hasSubgroup, setInActivity, setSuperGroup

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.activities.mdfundamentalactivities.ActivityNode

get_activityNodeOfRedefinedNode, getIncoming, getInGroup, getInInterruptibleRegion, getInPartition, getInStructuredNode, getOutgoing, getRedefinedNode, has_activityNodeOfRedefinedNode, hasIncoming, hasInGroup, hasInInterruptibleRegion, hasInPartition, hasOutgoing, hasRedefinedNode, setInStructuredNode

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

accept, addPropertyChangeListener, canAdd, canAdd, canAddChild, canBeDeleted, firePropertyChange, getClassType, getHumanName, getHumanType, getObjectParent, isEditable, removePropertyChangeListener, sGetID

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element

get_activityPartitionOfRepresents, get_commentOfAnnotatedElement, get_constraintOfConstrainedElement, get_diagramOfContext, get_directedRelationshipOfSource, get_directedRelationshipOfTarget, get_elementOfSyncElement, get_elementTaggedValue, get_elementValueOfElement, get_relationshipOfRelatedElement, getAppliedStereotype, getOwnedComment, getOwnedElement, getOwner, getSyncElement, getTaggedValue, has_activityPartitionOfRepresents, has_commentOfAnnotatedElement, has_constraintOfConstrainedElement, has_diagramOfContext, has_directedRelationshipOfSource, has_directedRelationshipOfTarget, has_elementOfSyncElement, has_elementValueOfElement, has_relationshipOfRelatedElement, hasAppliedStereotype, hasElementTaggedValue, hasOwnedComment, hasOwnedElement, hasTaggedValue, setOwner, setSyncElement

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 com.nomagic.uml2.ext.magicdraw.activities.mdstructuredactivities.ExecutableNode

get_clauseOfBody, get_clauseOfTest, get_exceptionHandlerOfHandlerBody, get_loopNodeOfBodyPart, get_loopNodeOfSetupPart, get_loopNodeOfTest, get_sequenceNodeOfExecutableNode, getHandler, has_exceptionHandlerOfHandlerBody, hasHandler, set_clauseOfBody, set_clauseOfTest, set_loopNodeOfBodyPart, set_loopNodeOfSetupPart, set_loopNodeOfTest, set_sequenceNodeOfExecutableNode

Methods inherited from interface com.nomagic.magicdraw.foundation.MDObject

getID, getMDExtension, getMdExtensions, setID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.base.ModelObject

get_representationText, getLocalID, ignoringRefGetValue, ignoringRefGetValue, isInvalid, isSet, refGetValue, refGetValue, refSetValue, refSetValue, set_representationText, setLocalID, sGetLocalID

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement

get_considerIgnoreFragmentOfMessage, get_durationObservationOfEvent, get_informationFlowOfInformationSource, get_informationFlowOfInformationTarget, get_messageOfSignature, get_namespaceOfMember, get_timeObservationOfEvent, getClientDependency, getName, getNameExpression, getNamespace, getQualifiedName, getSupplierDependency, getVisibility, has_considerIgnoreFragmentOfMessage, has_durationObservationOfEvent, has_informationFlowOfInformationSource, has_informationFlowOfInformationTarget, has_messageOfSignature, has_namespaceOfMember, has_timeObservationOfEvent, hasClientDependency, hasSupplierDependency, setName, setNameExpression, setNamespace, setVisibility

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Namespace

getElementImport, getImportedMember, getMember, getOwnedDiagram, getOwnedMember, getOwnedRule, getPackageImport, hasElementImport, hasImportedMember, hasMember, hasOwnedDiagram, hasOwnedMember, hasOwnedRule, hasPackageImport

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.classes.mdkernel.RedefinableElement

get_redefinableElementOfRedefinedElement, getRedefinedElement, getRedefinitionContext, has_redefinableElementOfRedefinedElement, hasRedefinedElement, hasRedefinitionContext, isLeaf, setLeaf

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refInvokeOperation, refInvokeOperation, refSetValue

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface com.nomagic.uml2.ext.magicdraw.activities.mdstructuredactivities.StructuredActivityNode

getActivity, getEdge, getNode, getStructuredNodeInput, getStructuredNodeOutput, getVariable, hasEdge, hasNode, hasStructuredNodeInput, hasStructuredNodeOutput, hasVariable, isMustIsolate, setActivity, setMustIsolate

Method Detail

getBodyPart

java.util.Collection<ExecutableNode> getBodyPart()

Returns the value of the 'Body Part' reference list. The list contents are of type ExecutableNode. It is bidirectional and its opposite is 'loop Node Of Body Part'. The set of ExecutableNodes that perform the repetitive computations of the loop. The bodyPart is executed as long as the test section produces a true value.

Returns:

the value of the 'Body Part' reference list.

See Also:

UMLPackage.getLoopNode_BodyPart(), ExecutableNode.get_loopNodeOfBodyPart()

Model:

opposite="_loopNodeOfBodyPart" ordered="false"

Generated:

getDecider

@CheckForNull
OutputPin getDecider()

Returns the value of the 'Decider' reference. It is bidirectional and its opposite is 'loop Node Of Decider'. An OutputPin on an Action in the test section whose Boolean value determines whether to continue executing the loop bodyPart.

Returns:

the value of the 'Decider' reference.

See Also:

setDecider(OutputPin), UMLPackage.getLoopNode_Decider(), OutputPin.get_loopNodeOfDecider()

Model:

opposite="_loopNodeOfDecider" required="true" ordered="false"

Generated:

setDecider

void setDecider(@CheckForNull
                OutputPin value)

Sets the value of the 'Decider' reference.

Parameters:

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

See Also:

getDecider()

Generated:

isTestedFirst

boolean isTestedFirst()

Returns the value of the 'Tested First' attribute. The default value is "false". If true, the test is performed before the first execution of the bodyPart. If false, the bodyPart is executed once before the test is performed.

Returns:

the value of the 'Tested First' attribute.

See Also:

setTestedFirst(boolean), com.nomagic.uml2.ext.magicdraw.metadata.UMLPackage#getLoopNode_TestedFirst()

Model:

default="false" dataType="com.nomagic.uml2.ext.magicdraw.Boolean" required="true" ordered="false"

Generated:

setTestedFirst

void setTestedFirst(boolean value)

Sets the value of the 'Tested First' attribute.

Parameters:

value - the new value of the 'Tested First' attribute.

See Also:

isTestedFirst()

Generated:

getResult

java.util.List<OutputPin> getResult()

Returns the value of the 'Result' containment reference list. The list contents are of type OutputPin. It is bidirectional and its opposite is 'loop Node Of Result'. A list of OutputPins that receive the loopVariable values after the last iteration of the loop and constitute the output of the LoopNode.

Returns:

the value of the 'Result' containment reference list.

See Also:

UMLPackage.getLoopNode_Result(), OutputPin.get_loopNodeOfResult()

Model:

opposite="_loopNodeOfResult" containment="true" resolveProxies="true"

Generated:

getLoopVariable

java.util.List<OutputPin> getLoopVariable()

Returns the value of the 'Loop Variable' containment reference list. The list contents are of type OutputPin. It is bidirectional and its opposite is 'loop Node Of Loop Variable'. A list of OutputPins that hold the values of the loop variables during an execution of the loop. When the test fails, the values are moved to the result OutputPins of the loop.

Returns:

the value of the 'Loop Variable' containment reference list.

See Also:

UMLPackage.getLoopNode_LoopVariable(), OutputPin.get_loopNodeOfLoopVariable()

Model:

opposite="_loopNodeOfLoopVariable" containment="true" resolveProxies="true"

Generated:

getBodyOutput

java.util.List<OutputPin> getBodyOutput()

Returns the value of the 'Body Output' reference list. The list contents are of type OutputPin. It is bidirectional and its opposite is 'loop Node Of Body Output'. The OutputPins on Actions within the bodyPart, the values of which are moved to the loopVariable OutputPins after the completion of each execution of the bodyPart, before the next iteration of the loop begins or before the loop exits.

Returns:

the value of the 'Body Output' reference list.

See Also:

UMLPackage.getLoopNode_BodyOutput(), OutputPin.get_loopNodeOfBodyOutput()

Model:

opposite="_loopNodeOfBodyOutput"

Generated:

getTest

java.util.Collection<ExecutableNode> getTest()

Returns the value of the 'Test' reference list. The list contents are of type ExecutableNode. It is bidirectional and its opposite is 'loop Node Of Test'. The set of ExecutableNodes executed in order to provide the test result for the loop.

Returns:

the value of the 'Test' reference list.

See Also:

UMLPackage.getLoopNode_Test(), ExecutableNode.get_loopNodeOfTest()

Model:

opposite="_loopNodeOfTest" required="true" ordered="false"

Generated:

getLoopVariableInput

java.util.List<InputPin> getLoopVariableInput()

Returns the value of the 'Loop Variable Input' containment reference list. The list contents are of type InputPin. It is bidirectional and its opposite is 'loop Node Of Loop Variable Input'. A list of InputPins whose values are moved into the loopVariable Pins before the first iteration of the loop.

Returns:

the value of the 'Loop Variable Input' containment reference list.

See Also:

UMLPackage.getLoopNode_LoopVariableInput(), InputPin.get_loopNodeOfLoopVariableInput()

Model:

opposite="_loopNodeOfLoopVariableInput" containment="true" resolveProxies="true"

Generated:

getSetupPart

java.util.Collection<ExecutableNode> getSetupPart()

Returns the value of the 'Setup Part' reference list. The list contents are of type ExecutableNode. It is bidirectional and its opposite is 'loop Node Of Setup Part'. The set of ExecutableNodes executed before the first iteration of the loop, in order to initialize values or perform other setup computations.

Returns:

the value of the 'Setup Part' reference list.

See Also:

UMLPackage.getLoopNode_SetupPart(), ExecutableNode.get_loopNodeOfSetupPart()

Model:

opposite="_loopNodeOfSetupPart" ordered="false"

Generated:

hasBodyPart

boolean hasBodyPart()
             throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasResult

boolean hasResult()
           throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasLoopVariable

boolean hasLoopVariable()
                 throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasBodyOutput

boolean hasBodyOutput()
               throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasTest

boolean hasTest()
         throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasLoopVariableInput

boolean hasLoopVariableInput()
                      throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated:

hasSetupPart

boolean hasSetupPart()
              throws javax.jmi.reflect.JmiException

Throws:

javax.jmi.reflect.JmiException

Generated: