edu.cmu.sei.aadl.model.instance
Interface SystemInstance

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

public interface SystemInstance
extends ComponentInstance

A representation of the model object 'System Instance'.

The following features are supported:

See Also:
InstancePackage.getSystemInstance()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void addConnectionInstance(ConnectionInstance value)
          Adds to the list the value of the 'Connection Instance' containment reference list
 void addSystemOperationMode(SystemOperationMode value)
          Adds to the list the value of the 'System Operation Mode' containment reference list
 void clearCurrentSystemOperationMode()
          Clear the mode states for a given SystemInstance.
 ConnectionInstance findConnectionInstance(FeatureInstance srcFI, FeatureInstance dstFI)
          find the Connection instance for these feature instances.
 ClassifierReference getClassifierReference()
          Returns the value of the 'Impl Name' attribute.
 org.eclipse.emf.common.util.EList getConnectionInstance()
          Returns the value of the 'Connection Instance' containment reference list.
 SystemOperationMode getCurrentSystemOperationMode()
          Get the current system operation mode of the system, or null if it has not been set.
 SystemOperationMode getInitialSystemOperationMode()
          Get the initial system operation mode, that is, the one whose member modes are all initial modes.
 SystemImpl getSystemImpl()
          Returns the value of the 'System Impl' reference
 org.eclipse.emf.common.util.EList getSystemOperationMode()
          Returns the value of the 'System Operation Mode' containment reference list.
 java.util.List getSystemOperationModesFor(java.util.List mis)
          get all SOMs that contain the ModeInstance list
 java.util.List getSystemOperationModesFor(ModeInstance mi)
          Get the system operation modes containing the given mode instance.
 void setClassifierReference(ClassifierReference cr)
          sets ClassifierReference
 void setCurrentSystemOperationMode(SystemOperationMode som)
          Sets the current modes of the component instances contained in this system instance to match the state of the specified system operation mode.
 void setSystemImpl(SystemImpl value)
          Sets the value of the 'System Impl' reference
 void setSystemOperationMode(SystemOperationMode som)
          Deprecated. Use setCurrentSystemOperationMode(SystemOperationMode) instead.
 
Methods inherited from interface edu.cmu.sei.aadl.model.instance.ComponentInstance
addComponentInstance, addEndToEndFlowInstance, addFeatureInstance, addFlowSpecInstance, addInModes, addModeInstance, addModeTransitionInstance, addSrcAccessConnection, doFlowSpecInstances, exists, findConnectionInstance, findEndToEndFlowInstance, findFeatureInstance, findFlowSpecInstance, findFlowSpecInstance, findInstanceObject, findModeInstance, findModeTransitionInstance, findSubcomponentInstance, getAllComponentInstances, getCategory, getChildren, getChildren, getComponentInstance, getComponentInstance, getCurrentMode, getEndToEndFlowInstance, getFeatureInstance, getFlowSpecInstance, getIncomingConnection, getIngoingConnection, getInModes, getModeInstance, getModeTransitionInstance, getOutcomingConnection, getOutgoingAccessConnection, getOutgoingConnection, getPreOrderComponentInstance, getReferencePathTo, getReferenceTo, getSrcAccessConnection, getSubcomponent, getXComponentClassifier, getXComponentImpl, getXComponentType, isModal, isModalSubcomponent, setCategory, setCurrentMode, setSubcomponent, testClassifier
 
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.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, 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

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getSystemImpl

SystemImpl getSystemImpl()
Returns the value of the 'System Impl' reference.

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

Returns:
the value of the 'System Impl' reference.
See Also:
setSystemImpl(SystemImpl), InstancePackage.getSystemInstance_SystemImpl()

setSystemImpl

void setSystemImpl(SystemImpl value)
Sets the value of the 'System Impl' reference.

Parameters:
value - the new value of the 'System Impl' reference.
See Also:
getSystemImpl()

getConnectionInstance

org.eclipse.emf.common.util.EList getConnectionInstance()
Returns the value of the 'Connection Instance' containment reference list. The list contents are of type ConnectionInstance.

Get the semantic connections contained in the system instance. This method is sensitive to the current system operation mode. If the current SOM is set, then this method only returns those connection 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 in the system instance; modifying the returned list in this case will change the model.

Returns:
the value of the 'Connection Instance' containment reference list.
See Also:
InstancePackage.getSystemInstance_ConnectionInstance()

addConnectionInstance

void addConnectionInstance(ConnectionInstance value)
Adds to the list the value of the 'Connection Instance' containment reference list.

Parameters:
value - the value to add to 'Connection Instance' containment reference list.

getSystemOperationMode

org.eclipse.emf.common.util.EList getSystemOperationMode()
Returns the value of the 'System Operation Mode' containment reference list. The list contents are of type SystemOperationMode.

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

Returns:
the value of the 'System Operation Mode' containment reference list.
See Also:
InstancePackage.getSystemInstance_SystemOperationMode()

addSystemOperationMode

void addSystemOperationMode(SystemOperationMode value)
Adds to the list the value of the 'System Operation Mode' containment reference list.

Parameters:
value - the value to add to 'System Operation Mode' containment reference list.

getSystemOperationModesFor

java.util.List getSystemOperationModesFor(ModeInstance mi)
Get the system operation modes containing the given mode instance.

Parameters:
mi - The mode instance to look for
Returns:
The system operation modes containing the given mode instance.

getSystemOperationModesFor

java.util.List getSystemOperationModesFor(java.util.List mis)
get all SOMs that contain the ModeInstance list

Parameters:
mis - List of mode instances
Returns:
SOM that match the ModeInstance list

getInitialSystemOperationMode

SystemOperationMode getInitialSystemOperationMode()
Get the initial system operation mode, that is, the one whose member modes are all initial modes. If the system instance is non-modal, that is, does not contain any components that have modes, then the initial mode is the special "No Modes" system operation mode that refers to an empty list of mode instances.


getClassifierReference

ClassifierReference getClassifierReference()
Returns the value of the 'Impl Name' attribute.


setClassifierReference

void setClassifierReference(ClassifierReference cr)
sets ClassifierReference


setCurrentSystemOperationMode

void setCurrentSystemOperationMode(SystemOperationMode som)
Sets the current modes of the component instances contained in this system instance to match the state of the specified system operation mode. The system operation mode is also set globally on the system instance. 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.

Parameters:
som - SystemOperationMode whose values are used to set the currentMode in the instance model
See Also:
clearCurrentSystemOperationMode(), getCurrentSystemOperationMode()

setSystemOperationMode

void setSystemOperationMode(SystemOperationMode som)
Deprecated. Use setCurrentSystemOperationMode(SystemOperationMode) instead.

Sets the current modes of the component instances contained in this system instance to match the state of the specified system operation mode. The system operation mode is also set globally on the system instance. 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.

Parameters:
som - SystemOperationMode whose values are used to set the currentMode in the instance model
See Also:
clearCurrentSystemOperationMode(), getCurrentSystemOperationMode()

getCurrentSystemOperationMode

SystemOperationMode getCurrentSystemOperationMode()
Get the current system operation mode of the system, or null if it has not been set.


clearCurrentSystemOperationMode

void clearCurrentSystemOperationMode()
Clear the mode states for a given SystemInstance. That is, the modal adapters for the model all have their modes set to null.


findConnectionInstance

ConnectionInstance findConnectionInstance(FeatureInstance srcFI,
                                          FeatureInstance dstFI)
find the Connection instance for these feature instances. The connection instance may point to the enclosing port group instance The connection instance may go through the feature to a subcomponent instance

This method is sensitive to the current system operation mode.

Parameters:
srcFI - source feature instance
dstFI - destination feature instance
Returns:
Connection instance with the specified source and destination, or null if no such connection exists in the current som.