edu.cmu.sei.aadl.model.feature
Interface Port

All Superinterfaces:
AbstractPort, AObject, org.eclipse.emf.ecore.EObject, Feature, FlowPoint, org.eclipse.core.runtime.IAdaptable, NamedElement, org.eclipse.emf.common.notify.Notifier, PropertyHolder
All Known Subinterfaces:
DataPort, EventDataPort, EventPort
All Known Implementing Classes:
DataPortImpl, EventDataPortImpl, EventPortImpl, PortImpl

public interface Port
extends AbstractPort, FlowPoint

A representation of the model object 'Port'.

The following features are supported:

See Also:
FeaturePackage.getPort()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 PortDirection getAllDirection()
          Get the port direction.
 PortDirection getAllDirection(AObject context)
          get the port direction, possibly from the ancestor feature If the context port group has an inverse port group type, we invert the direction.
 PortDirection getAllDirection(boolean shouldInvert)
          Get the port direction, but invert the direction if requested.
 PortDirection getDirection()
          Returns the value of the 'Direction' attribute.
 PortDirection getDirection(AObject context)
          get the port direction If the context port group has an inverse port group type, we invert the direction.
 PortDirection getDirection(boolean shouldInvert)
          Get the port direction, but invert the direction if requested.
 void setDirection(PortDirection value)
          Sets the value of the 'Direction' attribute
 
Methods inherited from interface edu.cmu.sei.aadl.model.core.Feature
getAllFeatureRefinements, getClassifierReference, getConnection, getFeaturesModeContext, getIncomingConnection, getOutgoingConnection, getRefinedReference, getRefinesFeature, getXAllClassifier, getXClassifier, getXRefines, isRefined, setClassifierReference, setRefined, setRefinedReference
 
Methods inherited from interface edu.cmu.sei.aadl.model.core.PropertyHolder
acceptsProperty, addProperty, addPropertyValue, checkPropertyAssociation, findPropertyAssociation, getProperties, getPropertyAssociation, getPropertyValue, getPropertyValueInternal, getPropertyValueList, getSimplePropertyValue, isModalPropertyValue, removeContainedPropertyAssociations, removeContainedPropertyAssociations, removePropertyAssociations, removePropertyAssociations, setContainedPropertyValue, setContainedPropertyValue, setContainedPropertyValue, setContainedPropertyValue, setProperties, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue
 
Methods inherited from interface edu.cmu.sei.aadl.model.core.NamedElement
getName, setName
 
Methods inherited from interface edu.cmu.sei.aadl.model.core.AObject
addComment, getAadlSpec, getAObjectRoot, getChildren, getComment, getContainingClassifier, getContainingClassifierNameSpace, getContainingComponentImpl, getContainingComponentType, getContainingPropertyAssociationDefinitionConstant, getContainingSubcomponent, getLocationReference, getReferencedObject, getSecondReferencedObject, getSystemInstance, setLocationReference, setLocationReference
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, 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.core.runtime.IAdaptable
getAdapter
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getDirection

PortDirection getDirection()
Returns the value of the 'Direction' attribute. The default value is "in". The literals are from the enumeration PortDirection.

If the meaning of the 'Direction' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Direction' attribute.
See Also:
PortDirection, setDirection(PortDirection), FeaturePackage.getPort_Direction()

setDirection

void setDirection(PortDirection value)
Sets the value of the 'Direction' attribute.

Parameters:
value - the new value of the 'Direction' attribute.
See Also:
PortDirection, getDirection()

getAllDirection

PortDirection getAllDirection()
Get the port direction. This method is the same as getDirection(). It has been provided to be compatible with the method set for information with refines inheritance

Returns:
PortDirection

getAllDirection

PortDirection getAllDirection(AObject context)
get the port direction, possibly from the ancestor feature If the context port group has an inverse port group type, we invert the direction. This method is the same as getDirection(AObject). It has been provided to be compatible with the method set for information with refines inheritance

Parameters:
context - the context of the feature or null
Returns:
PortDirection

getDirection

PortDirection getDirection(AObject context)
get the port direction If the context port group has an inverse port group type, we invert the direction. The context can be null or not a port group

Parameters:
context - the context of the feature or null
Returns:
PortDirection

getDirection

PortDirection getDirection(boolean shouldInvert)
Get the port direction, but invert the direction if requested. This is intended to be used in conjunction with ports retreived from a port group type using PortGroupType.getAllFeature(). The inverse flag should be based on the value returned by PortGroupType.areFeatureDirectionsInverted().

Parameters:
shouldInvert - true if the port direction should be inverted.
Returns:
The direction of the port, inverted if requrest.

getAllDirection

PortDirection getAllDirection(boolean shouldInvert)
Get the port direction, but invert the direction if requested. This is intended to be used in conjunction with ports retreived from a port group type using PortGroupType.getAllFeature(). The inverse flag should be based on the value returned by PortGroupType.areFeatureDirectionsInverted().

This method is the same as getDirection(boolean). It has been provided to be compatible with the method set for information with refines inheritance

Parameters:
shouldInvert - true if the port direction should be inverted.
Returns:
The direction of the port, inverted if requrest.