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

All Superinterfaces:
AObject, ComponentInstance, ConnectionInstanceEnd, Element, org.eclipse.emf.ecore.EObject, FlowElementInstance, org.eclipse.core.runtime.IAdaptable, InstanceObject, NamedElement, org.eclipse.emf.common.notify.Notifier
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
 
Fields inherited from interface edu.cmu.sei.aadl.aadl2.parsesupport.AObject
copyright
 
Method Summary
 void clearCurrentSystemOperationMode()
          Clear the mode states for a given SystemInstance.
 SystemOperationMode createSystemOperationMode()
          Creates a new SystemOperationMode and appends it to the 'System Operation Mode' containment reference list
 ConnectionInstance findConnectionInstance(FeatureInstance srcFI, FeatureInstance dstFI)
          find the Connection instance for these feature instances.
 java.util.List<ConnectionInstance> findConnectionInstances(Connection first, Connection second)
          Find all connection instances that pass through two declarative connections in the same order as given in the parameters.
 SystemOperationMode getCurrentSystemOperationMode()
          Get the current system operation mode of the system, or null if it has not been set.
 SystemOperationMode getInitialSystemOperationMode()
           
 SystemImplementation getSystemImplementation()
          Returns the value of the 'System Implementation' reference
 org.eclipse.emf.common.util.EList<SystemOperationMode> getSystemOperationModes()
          Returns the value of the 'System Operation Mode' containment reference list.
 java.util.List<SystemOperationMode> getSystemOperationModesFor(java.util.List<ModeInstance> mis)
          get all SOMs that contain the ModeInstance list
 java.util.List<SystemOperationMode> getSystemOperationModesFor(ModeInstance mi)
          Get the system operation modes containing the given mode instance.
 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 setSystemImplementation(SystemImplementation value)
          Sets the value of the 'System Implementation' reference
 
Methods inherited from interface edu.cmu.sei.aadl.aadl2.instance.ComponentInstance
createComponentInstance, createComponentInstance, createConnectionInstance, createEndToEndFlow, createFeatureInstance, createFlowSpecification, createModeInstance, createModeTransitionInstance, findConnectionInstance, findEndToEndFlowInstance, findFeatureInstance, findFlowSpecInstance, findInstanceObjects, findModeInstance, findModeTransitionInstance, findSubcomponentInstance, getAllComponentInstances, getCategory, getComponentInstances, getConnectionInstances, getEndToEndFlows, getFeatureInstances, getFlowSpecifications, getIndices, getInModes, getModeInstances, getModeTransitionInstances, getSubcomponent, setCategory, setCurrentMode, setSubcomponent
 
Methods inherited from interface edu.cmu.sei.aadl.aadl2.instance.ConnectionInstanceEnd
getDstConnectionInstances, getSrcConnectionInstances
 
Methods inherited from interface edu.cmu.sei.aadl.aadl2.instance.InstanceObject
getComponentInstancePath, getContainingComponentInstance, getExistsInModes, getInstanceObjectPath, getInstantiatedObjects, getSystemInstance, isActive
 
Methods inherited from interface edu.cmu.sei.aadl.aadl2.NamedElement
acceptsProperty, allNamespaces, checkPropertyAssociation, createOwnedPropertyAssociation, getName, getNamespace, getOwnedPropertyAssociations, getPropertyValue, getPropertyValueInternal, getPropertyValueList, getQualifiedName, getSimplePropertyValue, has_no_qualified_name, has_qualified_name, hasName, isDistinguishableFrom, qualifiedName, removePropertyAssociations, removePropertyAssociations, separator, setName, setPropertyValue, setPropertyValue, setPropertyValue
 
Methods inherited from interface edu.cmu.sei.aadl.aadl2.Element
allOwnedElements, createOwnedComment, getChildren, getContainingClassifier, getContainingComponentImpl, getElementRoot, getOwnedComments, getOwnedElements, getOwner, has_owner, mustBeOwned, not_own_self
 
Methods inherited from interface edu.cmu.sei.aadl.aadl2.parsesupport.AObject
getLocationReference, setLocationReference, setLocationReference
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getSystemOperationModes

org.eclipse.emf.common.util.EList<SystemOperationMode> getSystemOperationModes()
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()

createSystemOperationMode

SystemOperationMode createSystemOperationMode()
Creates a new SystemOperationMode and appends it to the 'System Operation Mode' containment reference list.

Returns:
The new SystemOperationMode.
See Also:
getSystemOperationModes()

getSystemImplementation

SystemImplementation getSystemImplementation()
Returns the value of the 'System Implementation' reference.

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

Returns:
the value of the 'System Implementation' reference.
See Also:
setSystemImplementation(SystemImplementation), InstancePackage.getSystemInstance_SystemImplementation()

setSystemImplementation

void setSystemImplementation(SystemImplementation value)
Sets the value of the 'System Implementation' reference.

Parameters:
value - the new value of the 'System Implementation' reference.
See Also:
getSystemImplementation()

getSystemOperationModesFor

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

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

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. This 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 feature 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.

findConnectionInstances

java.util.List<ConnectionInstance> findConnectionInstances(Connection first,
                                                           Connection second)
Find all connection instances that pass through two declarative connections in the same order as given in the parameters.

This method is sensitive to the current system operation mode.

Parameters:
first - the first connection that should occur in the connection instance
second - the connection that should occur after the first in the connection instance
Returns:
the list of connection instances

getSystemOperationModesFor

java.util.List<SystemOperationMode> 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.

getInitialSystemOperationMode

SystemOperationMode getInitialSystemOperationMode()