org.eclipse.papyrus.sysml14.deprecatedelements

Interface FlowPort

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

FlowPortCustomImpl, FlowPortImpl

public interface FlowPort
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Flow Port'. A FlowPort is an interaction point through which input and/or output of items such as data, material, or energy may flow. This enables the owning block to declare which items it may exchange with its environment and the interaction points through which the exchange is made. We distinguish between atomic flow port and a nonatomic flow port. Atomic flow ports relay items that are classified by a single Block, ValueType, DataType, or Signal classifier. A nonatomic flow port relays items of several types as specified by a FlowSpecification. Flow ports and associated flow specifications define “what can flow” between the block and its environment, whereas item flows specify “what does flow” in a specific usage context. Flow ports relay items to their owning block or to a connector that connects them with their owner’s internal parts (internal connector).

The following features are supported:

• Base Port
• Direction
• Is Atomic

See Also:

DeprecatedelementsPackage.getFlowPort()

Method Summary

Modifier and Type	Method and Description
org.eclipse.uml2.uml.Port	getBase_Port() Returns the value of the 'Base Port' reference
FlowDirection	getDirection() Returns the value of the 'Direction' attribute.
org.eclipse.uml2.uml.Image	getIcon()
boolean	isAtomic() Returns the value of the 'Is Atomic' attribute
void	setBase_Port(org.eclipse.uml2.uml.Port value) Sets the value of the 'Base Port' reference
void	setDirection(FlowDirection value) Sets the value of the 'Direction' attribute
void	setIsAtomic(boolean value) Sets the value of the 'Is Atomic' attribute

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

getBase_Port

org.eclipse.uml2.uml.Port getBase_Port()

Returns the value of the 'Base Port' reference.

If the meaning of the 'Base Port' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Base Port' reference.

See Also:

setBase_Port(Port), DeprecatedelementsPackage.getFlowPort_Base_Port()

setBase_Port

void setBase_Port(org.eclipse.uml2.uml.Port value)

Sets the value of the 'Base Port' reference.

Parameters:

value - the new value of the 'Base Port' reference.

See Also:

getBase_Port()

getDirection

FlowDirection getDirection()

Returns the value of the 'Direction' attribute. The default value is "inout". The literals are from the enumeration FlowDirection. Indicates the direction in which an atomic flow port relays its items. If the direction is set to “in,” then the items are relayed from an external connector via the flow port into the flow port’s owner (or one of its parts). If the direction is set to “out,” then the items are relayed from the flow port’s owner, via the flow port, through an external connector attached to the flow port. If the direction is set to “inout,” then items can flow both ways. By default, the value is inout.

Returns:

the value of the 'Direction' attribute.

See Also:

FlowDirection, setDirection(FlowDirection), DeprecatedelementsPackage.getFlowPort_Direction()

setDirection

void setDirection(FlowDirection value)

Sets the value of the 'Direction' attribute.

Parameters:

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

See Also:

FlowDirection, getDirection()

isAtomic

boolean isAtomic()

Returns the value of the 'Is Atomic' attribute. This is a derived attribute (derived from the flow port’s type). For a flow port typed by a flow specification the value of this attribute is False, otherwise the value is True.

Returns:

the value of the 'Is Atomic' attribute.

See Also:

setIsAtomic(boolean), DeprecatedelementsPackage.getFlowPort_IsAtomic()

setIsAtomic

void setIsAtomic(boolean value)

Sets the value of the 'Is Atomic' attribute.

Parameters:

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

See Also:

isAtomic()

getIcon

org.eclipse.uml2.uml.Image getIcon()