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

All Superinterfaces:
AObject, Classifier, org.eclipse.emf.ecore.EObject, org.eclipse.core.runtime.IAdaptable, NamedElement, org.eclipse.emf.common.notify.Notifier, PropertyHolder
All Known Implementing Classes:
PortGroupTypeImpl

public interface PortGroupType
extends Classifier

A representation of the model object 'Port Group Type'.

The following features are supported:

See Also:
FeaturePackage.getPortGroupType()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 boolean areFeatureDirectionsInverted()
          Should the directions of the features returned by getAllFeature() be inverted.
 boolean deepIsInverseOf(PortGroupType pgt)
          Determines if the two port group type by recursively unwrapping nested port groups.
 Feature findFeature(java.lang.String name)
          Find feature by name in port group type and supertypes.
 org.eclipse.emf.common.util.EList getAllFeature()
          Get a list of Feature objects representing those features in the port group type, including those from super types or inverses.
 PortGroupType getExtend()
          Returns the value of the 'Extend' reference
 org.eclipse.emf.common.util.EList getFeature()
          Get a list of Feature objects representing those features declared locally in the PortGroupType.
 PortGroupFeatures getFeatures()
          Returns the value of the 'Features' containment reference
 int getIndexOf(Feature feature)
          return the index of the feature in the port group type
 ClassifierReference getInverseClassifierReference()
          get inverse reference names from ClassifierReference
 PortGroupType getInverseOf()
          Returns the value of the 'Inverse Of' reference
 java.lang.String getInverseOfQualifiedName()
          get qualified name of inverse. null if no inverse
 java.lang.String getPackageName()
          returns a package name if the componenttype is contained in a package It retrieves the name from the containing AadlPackage object
 java.lang.String getQualifiedName()
          get qualified componenttype name.
 boolean isInverseOf()
          returns true if this port group type is an inverse of another port group type In this case the direction of the features returned must be inverted by the recipient of the feature list.
 boolean isInverseOf(PortGroupType pgt)
          returns true of this port group type is the inverse of the port group type pgt
 void setExtend(PortGroupType value)
          Sets the value of the 'Extend' reference
 void setFeatures(PortGroupFeatures value)
          Sets the value of the 'Features' containment reference
 void setInverseClassifierReference(ClassifierReference cr)
          set inverse reference names from ClassifierReference
 void setInverseOf(PortGroupType value)
          Sets the value of the 'Inverse Of' reference
 
Methods inherited from interface edu.cmu.sei.aadl.model.core.Classifier
addAnnexSubclause, getAllPropertyAssociation, getAnnexSubclause, getExtendedClassifierReference, getExtendedQualifiedName, getXAllExtend, getXAllExtendPlusSelf, getXAllFeature, getXExtend, hasExtends, setExtendedClassifierReference
 
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

getExtend

PortGroupType getExtend()
Returns the value of the 'Extend' reference.

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

Returns:
the value of the 'Extend' reference.
See Also:
setExtend(PortGroupType), FeaturePackage.getPortGroupType_Extend()

setExtend

void setExtend(PortGroupType value)
Sets the value of the 'Extend' reference.

Parameters:
value - the new value of the 'Extend' reference.
See Also:
getExtend()

getInverseOf

PortGroupType getInverseOf()
Returns the value of the 'Inverse Of' reference.

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

Returns:
the value of the 'Inverse Of' reference.
See Also:
setInverseOf(PortGroupType), FeaturePackage.getPortGroupType_InverseOf()

setInverseOf

void setInverseOf(PortGroupType value)
Sets the value of the 'Inverse Of' reference.

Parameters:
value - the new value of the 'Inverse Of' reference.
See Also:
getInverseOf()

getFeatures

PortGroupFeatures getFeatures()
Returns the value of the 'Features' containment reference.

If the meaning of the 'Features' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Features' containment reference.
See Also:
setFeatures(PortGroupFeatures), FeaturePackage.getPortGroupType_Features()

getFeature

org.eclipse.emf.common.util.EList getFeature()
Get a list of Feature objects representing those features declared locally in the PortGroupType.

Returns:
A list of Feature objects

areFeatureDirectionsInverted

boolean areFeatureDirectionsInverted()
Should the directions of the features returned by getAllFeature() be inverted. This includes inverting the directions of features of nested port groups.


getAllFeature

org.eclipse.emf.common.util.EList getAllFeature()
Get a list of Feature objects representing those features in the port group type, including those from super types or inverses. In case of an inverse port group type, we returns the ports of the inverse target.

Returns:
A list of Feature objects

setFeatures

void setFeatures(PortGroupFeatures value)
Sets the value of the 'Features' containment reference.

Parameters:
value - the new value of the 'Features' containment reference.
See Also:
getFeatures()

setInverseClassifierReference

void setInverseClassifierReference(ClassifierReference cr)
set inverse reference names from ClassifierReference


getInverseClassifierReference

ClassifierReference getInverseClassifierReference()
get inverse reference names from ClassifierReference


getPackageName

java.lang.String getPackageName()
returns a package name if the componenttype is contained in a package It retrieves the name from the containing AadlPackage object

Specified by:
getPackageName in interface Classifier

getQualifiedName

java.lang.String getQualifiedName()
get qualified componenttype name. Always a String

Specified by:
getQualifiedName in interface Classifier

getInverseOfQualifiedName

java.lang.String getInverseOfQualifiedName()
get qualified name of inverse. null if no inverse


findFeature

Feature findFeature(java.lang.String name)
Find feature by name in port group type and supertypes. A feature of a port group type is either a port or a port group.

Parameters:
name - the name of the feature
Returns:
the feature object if found, null otherwise

isInverseOf

boolean isInverseOf()
returns true if this port group type is an inverse of another port group type In this case the direction of the features returned must be inverted by the recipient of the feature list.

Returns:
true if the port group type is the inverse of another

isInverseOf

boolean isInverseOf(PortGroupType pgt)
returns true of this port group type is the inverse of the port group type pgt

Parameters:
pgt - PortGroupType the port group type to compare to
Returns:
boolean true if they are inverse of each other

deepIsInverseOf

boolean deepIsInverseOf(PortGroupType pgt)
Determines if the two port group type by recursively unwrapping nested port groups. This is more thorough than isInverseOf() because that method only relies on the declared inverses in the port group type declarations.

Parameters:
pgt -

getIndexOf

int getIndexOf(Feature feature)
return the index of the feature in the port group type

Parameters:
feature - Feature
Returns:
int index of feature or -1 if not found