|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ComponentInstance
A representation of the model object 'Component Instance'.
The following features are supported:
Feature Instance
Component Instance
Subcomponent
Src Access Connection
Mode Instance
Mode Transition Instance
Category
In Modes
Flow Spec Instance
End To End Flow Instance
InstancePackage.getComponentInstance()
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
addComponentInstance(ComponentInstance value)
Adds to the list the value of the ' Component Instance ' containment reference list |
void |
addEndToEndFlowInstance(EndToEndFlowInstance value)
Adds to the list the value of the ' End To End Flow Instance ' containment reference list |
void |
addFeatureInstance(FeatureInstance value)
Adds to the list the value of the ' Feature Instance ' containment reference list |
void |
addFlowSpecInstance(FlowSpecInstance value)
Adds to the list the value of the ' Flow Spec Instance ' containment reference list |
void |
addInModes(ModeInstance value)
Adds to the list the value of the ' In Modes ' reference list |
void |
addModeInstance(ModeInstance value)
Adds to the list the value of the ' Mode Instance ' containment reference list |
void |
addModeTransitionInstance(ModeTransitionInstance value)
Adds to the list the value of the ' Mode Transition Instance ' containment reference list |
void |
addSrcAccessConnection(AccessConnectionInstance value)
Adds to the list the value of the ' Src Access Connection ' reference list |
void |
doFlowSpecInstances()
add flowspec instances to the component instance |
boolean |
exists()
Does the component exist in the current system operation mode of its containing system instance? |
org.eclipse.emf.common.util.EList |
findConnectionInstance(Connection conn)
Find the semantic connection instances that pass through this component instance that utilize the given connection. |
EndToEndFlowInstance |
findEndToEndFlowInstance(EndToEndFlow ete)
Find the end to end flow instance of this component that corresponds to the given end to end flow. |
FeatureInstance |
findFeatureInstance(Feature feature)
find the feature instance of this component instance |
FlowSpecInstance |
findFlowSpecInstance(FeatureInstance srcFeatureInstance)
find the flowspec instance of this component instance |
FlowSpecInstance |
findFlowSpecInstance(FlowSpec flowspec)
find the flowspec instance of this component instance |
java.util.Collection |
findInstanceObject(org.eclipse.emf.common.util.EList referencePath)
Find the instance object based on the referencePath relative to this component instance. |
ModeInstance |
findModeInstance(Mode mode)
find the mode instance of this component instance |
ModeTransitionInstance |
findModeTransitionInstance(ModeTransition mt)
find the mode transition instance of this component instance |
ComponentInstance |
findSubcomponentInstance(Subcomponent sc)
find the subcomponent instance of this component instance This method is sensitive to the current system operation mode of the containing system instance. |
org.eclipse.emf.common.util.EList |
getAllComponentInstances()
Return all component instances in the containment structure rooted at this component, including this component. |
ComponentCategory |
getCategory()
Returns the value of the 'Category' attribute. |
org.eclipse.emf.common.util.EList |
getChildren()
get the children of a ComponentInstance object This will be the content or in case of a modal
ComponentInstance the subset of children that is active in a given mode. |
org.eclipse.emf.common.util.EList |
getChildren(ModeInstance mode)
Get the child of a component instance object that exist in the given mode. |
org.eclipse.emf.common.util.EList |
getComponentInstance()
Returns the value of the 'Component Instance' containment reference list. |
org.eclipse.emf.common.util.EList |
getComponentInstance(ModeInstance mode)
retrieve the subset of sub-component instances that are part of the specified mode |
ModeInstance |
getCurrentMode()
Get the mode this component is currently projected into. |
org.eclipse.emf.common.util.EList |
getEndToEndFlowInstance()
Returns the value of the 'End To End Flow Instance' containment reference list. |
org.eclipse.emf.common.util.EList |
getFeatureInstance()
Returns the value of the 'Feature Instance' containment reference list. |
org.eclipse.emf.common.util.EList |
getFlowSpecInstance()
Returns the value of the 'Flow Spec Instance' containment reference list. |
org.eclipse.emf.common.util.EList |
getIncomingConnection(Feature feature)
get incoming connections for specified feature |
org.eclipse.emf.common.util.EList |
getIngoingConnection(Feature feature)
get ingoing connections for specified feature connections to within the ocmponent for which this feature is the source |
org.eclipse.emf.common.util.EList |
getInModes()
Returns the value of the 'In Modes' reference list. |
org.eclipse.emf.common.util.EList |
getModeInstance()
Returns the value of the 'Mode Instance' containment reference list. |
org.eclipse.emf.common.util.EList |
getModeTransitionInstance()
Returns the value of the 'Mode Transition Instance' containment reference list. |
org.eclipse.emf.common.util.EList |
getOutcomingConnection(Feature feature)
get outcoming connections for specified feature connections from within the ocmponent for which this feature is the destination |
org.eclipse.emf.common.util.EList |
getOutgoingAccessConnection()
get outgoing access connections for bus/data component |
org.eclipse.emf.common.util.EList |
getOutgoingConnection(Feature feature)
get outgoing connections for specified feature |
org.eclipse.emf.common.util.EList |
getPreOrderComponentInstance(ComponentCategory cat)
returns preorder list of component instances of the specified category. |
java.util.List |
getReferencePathTo()
Get a List containing the subcomponent path that references the
subcomponent associated the component instance. |
ReferenceValue |
getReferenceTo()
Create a ReferenceValue that references the subcomponent
associated with the component instance. |
org.eclipse.emf.common.util.EList |
getSrcAccessConnection()
Returns the value of the 'Src Access Connection' reference list. |
Subcomponent |
getSubcomponent()
Returns the value of the 'Subcomponent' reference |
ComponentClassifier |
getXComponentClassifier()
Get the ComponentClassifier associated with this component instance. |
ComponentImpl |
getXComponentImpl()
Get the ComponentImpl associated with this component instance. |
ComponentType |
getXComponentType()
Get the ComponentType associated with this component instance. |
boolean |
isModal()
Is the component modal? |
boolean |
isModalSubcomponent()
Is the component a modal subcompnent? |
void |
setCategory(ComponentCategory value)
Sets the value of the ' Category ' attribute |
void |
setCurrentMode(ModeInstance mode)
Project this component into the given mode. |
void |
setSubcomponent(Subcomponent value)
Sets the value of the ' Subcomponent ' reference |
boolean |
testClassifier(java.util.Set classifiers)
Test a component against a set of ComponentClassifier s. |
Methods inherited from interface edu.cmu.sei.aadl.model.instance.InstanceObject |
---|
getComponentInstanceList, getComponentInstancePath, getContainingComponentInstance, getInstanceObjectPath, getInstantiatedObjects, getSystemInstance |
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, getComment, getContainingClassifier, getContainingClassifierNameSpace, getContainingComponentImpl, getContainingComponentType, getContainingPropertyAssociationDefinitionConstant, getContainingSubcomponent, getLocationReference, getReferencedObject, getSecondReferencedObject, 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 |
---|
static final java.lang.String copyright
Method Detail |
---|
org.eclipse.emf.common.util.EList getFeatureInstance()
FeatureInstance
.
If the meaning of the 'Feature Instance' containment reference list isn't clear, there really should be more of a description here...
InstancePackage.getComponentInstance_FeatureInstance()
void addFeatureInstance(FeatureInstance value)
Feature Instance
' containment reference list.
value
- the value to add to 'Feature Instance' containment reference list.org.eclipse.emf.common.util.EList getComponentInstance()
ComponentInstance
.
Get the component instances for the subcomponents that are part of this component instance.
This method is sensitive to the
current system
operation mode
. The assumption is that this component instance
{exists in the current system operation mode
if it is being queried.
If this object is not part of a system instance, then
all the component instances are returned; modifying the returned list in this
case will change the model. If this object is part of a system
instance and the current SOM is set, then this method only returns those
component instances that exist in the current SOM. Modifying the
returned list in this case will not change the model. If the current SOM
is not set, then it returns all the component instances;
modifying the returned list in this case will change
the model.
InstancePackage.getComponentInstance_ComponentInstance()
org.eclipse.emf.common.util.EList getAllComponentInstances()
current system
operation mode
. The assumption is that this component instance
{exists in the current system operation mode
if it is being queried.
If this object is not part of a system instance, then
all the component instances are returned. If this object is part of a system
instance and the current SOM is set, then this method only returns those
component instances that exist in the current SOM. If the current SOM
is not set, then it returns all the component instances.
void addComponentInstance(ComponentInstance value)
Component Instance
' containment reference list.
value
- the value to add to 'Component Instance' containment reference list.Subcomponent getSubcomponent()
If the meaning of the 'Subcomponent' reference isn't clear, there really should be more of a description here...
setSubcomponent(Subcomponent)
,
InstancePackage.getComponentInstance_Subcomponent()
void setSubcomponent(Subcomponent value)
Subcomponent
' reference.
value
- the new value of the 'Subcomponent' reference.getSubcomponent()
org.eclipse.emf.common.util.EList getSrcAccessConnection()
AccessConnectionInstance
.
It is bidirectional and its opposite is 'Src
'.
Get the access connection instances that begin at this component instance.
This method is sensitive to the
current system
operation mode
. The assumption is that this component instance
{exists in the current system operation mode
if it is being queried.
If this object is not part of a system instance, then
all the connections are returned; modifying the returned list in this
case will change the model. If this object is part of a system
instance and the current SOM is set, then this method only returns those
connections instances that exist in the current SOM. Modifying the
returned list in this case will not change the model. If the current SOM
is not set, then it returns all the connection instances;
modifying the returned list in this case will change
the model.
InstancePackage.getComponentInstance_SrcAccessConnection()
,
AccessConnectionInstance.getSrc()
void addSrcAccessConnection(AccessConnectionInstance value)
Src Access Connection
' reference list.
value
- the value to add to 'Src Access Connection' reference list.org.eclipse.emf.common.util.EList getModeInstance()
ModeInstance
.
If the meaning of the 'Mode Instance' containment reference list isn't clear, there really should be more of a description here...
InstancePackage.getComponentInstance_ModeInstance()
void addModeInstance(ModeInstance value)
Mode Instance
' containment reference list.
value
- the value to add to 'Mode Instance' containment reference list.org.eclipse.emf.common.util.EList getModeTransitionInstance()
ModeTransitionInstance
.
If the meaning of the 'Mode Transition Instance' containment reference list isn't clear, there really should be more of a description here...
InstancePackage.getComponentInstance_ModeTransitionInstance()
void addModeTransitionInstance(ModeTransitionInstance value)
Mode Transition Instance
' containment reference list.
value
- the value to add to 'Mode Transition Instance' containment reference list.ComponentCategory getCategory()
"DATA"
.
The literals are from the enumeration ComponentCategory
.
If the meaning of the 'Category' attribute isn't clear, there really should be more of a description here...
ComponentCategory
,
setCategory(ComponentCategory)
,
InstancePackage.getComponentInstance_Category()
void setCategory(ComponentCategory value)
Category
' attribute.
value
- the new value of the 'Category' attribute.ComponentCategory
,
getCategory()
org.eclipse.emf.common.util.EList getInModes()
ModeInstance
.
If the meaning of the 'In Modes' reference list isn't clear, there really should be more of a description here...
InstancePackage.getComponentInstance_InModes()
void addInModes(ModeInstance value)
In Modes
' reference list.
value
- the value to add to 'In Modes' reference list.org.eclipse.emf.common.util.EList getFlowSpecInstance()
FlowSpecInstance
.
If the meaning of the 'Flow Spec Instance' containment reference list isn't clear, there really should be more of a description here...
InstancePackage.getComponentInstance_FlowSpecInstance()
void addFlowSpecInstance(FlowSpecInstance value)
Flow Spec Instance
' containment reference list.
value
- the value to add to 'Flow Spec Instance' containment reference list.org.eclipse.emf.common.util.EList getEndToEndFlowInstance()
EndToEndFlowInstance
.
Get the end-to-end flow instances that are part of this component instance.
This method is sensitive to the
current system
operation mode
. The assumption is that this component instance
{exists in the current system operation mode
if it is being queried.
If this object is not part of a system instance, then
all the end to end flows are returned; modifying the returned list in this
case will change the model. If this object is part of a system
instance and the current SOM is set, then this method only returns those
end to end flow instances that exist in the current SOM. Modifying the
returned list in this case will not change the model. If the current SOM
is not set, then it returns all the end to end flow instances;
modifying the returned list in this case will change
the model.
InstancePackage.getComponentInstance_EndToEndFlowInstance()
void addEndToEndFlowInstance(EndToEndFlowInstance value)
End To End Flow Instance
' containment reference list.
value
- the value to add to 'End To End Flow Instance' containment reference list.ComponentImpl getXComponentImpl()
ComponentImpl
associated with this component instance.
null
if one cannot be found.ComponentType getXComponentType()
ComponentType
associated with this component instance.
null
if one cannot be found.ComponentClassifier getXComponentClassifier()
ComponentClassifier
associated with this component instance.
null
if one cannot be found.ComponentInstance findSubcomponentInstance(Subcomponent sc)
This method is sensitive to the current system operation mode of the containing system instance. The component instance corresponding ot the subcomponent is only returned if it exists in the current som.
sc
- subcomponent
FeatureInstance findFeatureInstance(Feature feature)
feature
- feature whose instance is to be found
FlowSpecInstance findFlowSpecInstance(FlowSpec flowspec)
flowspec
- flowspec whose instance is to be found
EndToEndFlowInstance findEndToEndFlowInstance(EndToEndFlow ete)
This method is sensitive to the current system operation mode
. It only returns the end to end flow
instance if it exists in the current mode.
ete
- endtoendflow whose instance is to be found
ModeInstance findModeInstance(Mode mode)
mode
- mode whose instance is to be found
ModeTransitionInstance findModeTransitionInstance(ModeTransition mt)
mt
- mode transition whose instance is to be found
org.eclipse.emf.common.util.EList findConnectionInstance(Connection conn)
This method is sensitive to the current system operation mode
. It only returns those connection
instances that exist in the current SOM.
conn
- Connection whose instance is to be found
org.eclipse.emf.common.util.EList getComponentInstance(ModeInstance mode)
mode
- ModeInstance to be used to select the subset
org.eclipse.emf.common.util.EList getPreOrderComponentInstance(ComponentCategory cat)
cat
- component category
org.eclipse.emf.common.util.EList getChildren()
content
or in case of a modal
ComponentInstance the subset of children that is active in a given mode.
The method assumes the component exists in the current system operation
mode because otherwise how would the caller have a reference to it.
getChildren
in interface AObject
org.eclipse.emf.common.util.EList getChildren(ModeInstance mode)
mode
- The mode instance
boolean testClassifier(java.util.Set classifiers)
ComponentClassifier
s.
true
if the given set is empty!ReferenceValue getReferenceTo()
ReferenceValue
that references the subcomponent
associated with the component instance. The reference is rooted at the
system implementation associated with the system instance that contains
the component instance. Returns null
if ci
is a SystemInstance
. The resulting value is useful, for example,
for being use the value of a contained property association.
java.util.List getReferencePathTo()
List
containing the subcomponent path that references the
subcomponent associated the component instance. The reference is rooted
at the system implementation associated with the system instance that
contains the component instance. The resulting list is useful for setting
the "applies to" clause of a contained property association.
Subcomponent
objects describing the path to the
component.java.util.Collection findInstanceObject(org.eclipse.emf.common.util.EList referencePath)
This method is sensitive to the current system operation mode of the containing system instance. The object is only returned if it exists in the current som.
referencePath
- sequence of pointers into the declarative model to
subcomponents, features, etc.
org.eclipse.emf.common.util.EList getOutgoingConnection(Feature feature)
feature
- component feature that is the source of a connection
org.eclipse.emf.common.util.EList getOutgoingAccessConnection()
org.eclipse.emf.common.util.EList getIncomingConnection(Feature feature)
feature
- component feature that is the source of a connection
org.eclipse.emf.common.util.EList getOutcomingConnection(Feature feature)
feature
- feature that is the destination of a connection
org.eclipse.emf.common.util.EList getIngoingConnection(Feature feature)
feature
- feature that is the source of a connection
FlowSpecInstance findFlowSpecInstance(FeatureInstance srcFeatureInstance)
srcFeatureInstance
- feature instance that is the source of the flowspecinstance
void doFlowSpecInstances()
void setCurrentMode(ModeInstance mode)
getModeInstance()
. This method is only intended
to be used internally. There is an invariant over the instance model
that if the current system operation mode of the root system instance is
non-null
, then the "current mode" state of the component
instances in the model match that state.
mode
- The mode to project this component into, or null
if it is not projected into any mode.ModeInstance getCurrentMode()
null
if it is not projected into any mode.boolean isModal()
!getModeInstance().isEmpty()
, but communicates a clearer
semantic message and the model.
boolean isModalSubcomponent()
!getInModes().isEmpty()
, but
communicates a clearer semantic message about the model.
boolean exists()
modal subcomponent
or if
the current mode of the parent is contained in the component's
mode list
.
If the containing system instance does not have a current system
operation mode set, then this returns true
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |