Main Content

Author Architecture Models

Represent system architecture using components, ports, and interfaces

Model the physical, functional, and logical architecture of a system. Create visual representations with components, ports, and connections. Components represent architectural systems or subsystems to be used in system design. You can decompose components to add detail and define hierarchical relationships, and you can reuse and reference components across composition models. Create variant components and implement multiple design alternatives or variants, chosen based on programmatic rules.

Specify information exchange between components with interfaces. An interface defines the type, dimensions, units, and structure of the data contained within a port and exchanged between components. You can define interfaces locally that are saved with the model, or you can define interfaces in a System Composer™ interface data dictionary to be used across models.

Use architectural spotlight views to analyze component dependencies and hierarchy. Build an architecture model interactively through the user interface or programmatically using the command line.

Blocks

ComponentAdd component to an architecture model
Reference ComponentLink to an architectural definition or Simulink behavior
Variant ComponentAdd components with alternative designs
AdapterConnect components with different interfaces

Classes

expand all

systemcomposer.arch.ElementBase class of all model elements
systemcomposer.arch.ArchitectureClass that represents architecture in model
systemcomposer.arch.ModelClass that represents System Composer model
systemcomposer.arch.BaseComponentCommon base class for all components in architecture model
systemcomposer.arch.ComponentClass that represents component
systemcomposer.arch.VariantComponentClass that represents variant component in System Composer model
systemcomposer.arch.BasePortCommon base class for all ports in architecture model
systemcomposer.arch.ArchitecturePortClass that represents input and output ports of architecture
systemcomposer.arch.ComponentPortClass that represents input and output ports of component
systemcomposer.arch.ConnectorClass that represents connector between ports
systemcomposer.interface.DictionaryClass that represents interface dictionary of architecture model
systemcomposer.interface.SignalElementClass that represents element in signal interface
systemcomposer.interface.SignalInterfaceClass that represents signal interface

Functions

expand all

systemcomposer.loadModelLoad System Composer model
systemcomposer.openModelOpen System Composer model
openOpen architecture model
saveSave architecture model or data dictionary
closeClose model
getPortGet port from component
setPropertySet property value corresponding to stereotype applied to element
getPropertyGet property value corresponding to stereotype applied to element
getPropertyValueGet value of architecture property
getEvaluatedPropertyValueGet evaluated value of property from component
getStereotypePropertiesGet stereotype property names on element
renameProfileRename profile in model
systemcomposer.createModelCreate System Composer model
addComponentAdd components to architecture
addPortAdd ports to architecture
setNameSet name for port
connectCreate architecture model connections
lookupSearch for architecture element
destroyRemove model element
addChoiceAdd variant choices to variant component
addVariantComponentAdd variant components to architecture
getActiveChoiceGet active choice on variant component
getChoicesGet available choices in variant component
getConditionReturn variant control on choice within variant component
makeVariantConvert component to variant choice
setActiveChoiceSet active choice on variant component
setConditionSet condition on variant choice
destroyRemove model element
systemcomposer.createDictionaryCreate data dictionary
systemcomposer.openDictionaryOpen data dictionary
saveToDictionarySave interfaces to dictionary
linkDictionaryLink data dictionary to architecture model
unlinkDictionaryUnlink data dictionary from architecture model
addReferenceAdd reference to dictionary
removeReferenceRemove reference to dictionary
addInterfaceCreate named interface in interface dictionary
removeInterfaceRemove named interface from interface dictionary
setInterfaceSet interface for port
createAnonymousInterfaceCreate and set anonymous interface for port
getInterfaceGet object for named interface in interface dictionary
getInterfaceNamesGet names of all interfaces in interface dictionary
destroyRemove model element
addElementAdd signal interface element
removeElementRemove signal interface element
getElementGet object for signal interface element
setNameSet name for signal interface element
setTypeSet type for signal interface element
setDimensionsSet dimensions for signal interface element
setUnitsSet units for signal interface element
setComplexitySet complexity for signal interface element
setMinimumSet minimum for signal interface element
setMaximumSet maximum for signal interface element
setDescriptionSet description for signal interface element
getSourceElementGets signal interface elements selected on source port for connection
getDestinationElementGets signal interface elements selected on destination port for connection
destroyRemove model element
saveAsModelSave architecture of component to separate model
linkToModelLink component to a model
inlineComponentInline reference architecture or behavior into model

Topics

Compose Architecture Visually

Create architecture models using built-in model element types, such as components, ports, and connections.

Decompose and Reuse Components

Configure components for reuse across models.

Define Interfaces

Specify interfaces between components with elements containing data types, dimensions, and units.

Assign Interfaces to Ports

Assign interfaces to ports and reconcile incompatible interfaces using an Adapter block.

Save, Link, and Delete Interfaces

Use interface definitions across models.

Reference Data Dictionaries

Use referenced data dictionaries across models.

Interface Adapter

Map similar interfaces between ports.

Create Spotlight Views

View components in the context of the entire architecture.

Featured Examples