Author Architecture Models

Represent system architecture using components, ports, and interfaces

Model physical and logical architecture of a system. An interface defines the type, dimensions, units, and structure of the data. You can define interfaces saved with the model, or in a data dictionary to be used across models.

Create a visual representation with components, ports, and connections. Specify information exchange between components with interfaces.

Decompose components to add detail and define hierarchical relationships. Use different architecture views to analyze component dependencies and hierarchy. Share components and interfaces with other models.

Blocks

Component	Add component to an architecture model
Reference Component	Link to an architectural definition or Simulink behavior
Variant Component	Add components with alternative designs
Adapter	Connect components with different interfaces

Classes

expand all

Model Elements

`systemcomposer.arch.Element`	Base class of all model elements
`systemcomposer.arch.Architecture`	Class that represents architecture in architecture model
`systemcomposer.arch.Model`	Represent System Composer model
`systemcomposer.arch.BaseComponent`	Common base class for all components in architecture model
`systemcomposer.arch.Component`	Class that represents component or view component
`systemcomposer.arch.VariantComponent`	Represent variant component in System Composer model
`systemcomposer.arch.BasePort`	Common base class for all ports in architecture model
`systemcomposer.arch.ArchitecturePort`	Represent input and output ports of architecture
`systemcomposer.arch.ComponentPort`	Represents input and output ports of component
`systemcomposer.arch.Connector`	Class that represents connector between ports

Interfaces

`systemcomposer.interface.Dictionary`	Class that represents an element in the signal interface
`systemcomposer.interface.SignalElement`	Class that represents element in signal interface
`systemcomposer.interface.SignalInterface`	Class that represents structure of signal interface

Queries

systemcomposer.query.Constraint Represent query constraint

Functions

expand all

Model Management

`loadModel`	Load architecture model
`open`	Open architecture model
`openModel`	Open System Composer architecture model
`getPort`	Get port from component
`getEvaluatedPropertyValue`	Get evaluated value of property from component
`openViews`	Open architecture views editor
`save`	Save the architecture model or data dictionary
`find`	Find architecture elements using query
`close`	Close System Composer model
`renameProfile`	Rename profile in model

Model Building

`addComponent`	Add components to architecture
`addPort`	Add ports to architecture
`connect`	Create architecture model connections
`createModel`	Create a System Composer model
`createViewArchitecture`	Create view
`lookup`	Search for architecture element
`destroy`	Remove and destroy model element

Variant Management

`addChoice`	Add variant choices to variant component
`addVariantComponent`	Add variant components to architecture
`getActiveChoice`	Get active choice on variant component
`getChoices`	Get available choices in variant component
`getCondition`	Return variant control on choice within variant component
`makeVariant`	Convert component to variant choice
`setActiveChoice`	Set active choice on variant component
`setCondition`	Set condition on variant choice

Interface Management

`systemcomposer.createDictionary`	Create data dictionary
`systemcomposer.openDictionary`	Open data dictionary
`linkDictionary`	Link data dictionary to architecture model
`unlinkDictionary`	Unlink data dictionary from architecture model
`addInterface`	Create named interface in interface dictionary
`removeInterface`	Remove named interface from interface dictionary
`setInterface`	Set interface for port
`createAnonymousInterface`	Create and set anonymous interface for port
`getInterface`	Get object for named interface in interface dictionary
`getInterfaceNames`	Get names of all interfaces in interface dictionary
`destroy`	Remove and destroy model element

Interface Element Management

`addElement`	Add signal interface element
`removeElement`	Remove a signal interface element
`getElement`	Get object for signal interface element
`setName`	Set name for signal interface element
`setType`	Set type for signal interface element
`setDimensions`	Set dimensions for signal interface element
`setUnits`	Set units for signal interface element
`setComplexity`	Set complexity for signal interface element
`setMinimum`	Set minimum for signal interface element
`setMaximum`	Set maximum for signal interface element
`setDescription`	Set description for signal interface element
`getSourceElement`	Gets signal elements selected on source port for connection
`getDestinationElement`	Gets signal elements selected on destination port for connection
`destroy`	Remove and destroy model element