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 an architecture in an architecture model
`systemcomposer.arch.Model`	Represent a System Composer model
`systemcomposer.arch.BaseComponent`	Common base class for all components in an architecture model
`systemcomposer.arch.Component`	Class that represents a component or view component
`systemcomposer.arch.VariantComponent`	Represent a variant component in a System Composer model
`systemcomposer.arch.BasePort`	Common base class for all ports in an architecture model
`systemcomposer.arch.ArchitecturePort`	Represent input and output ports of an architecture
`systemcomposer.arch.ComponentPort`	Represent input and output ports of a component
`systemcomposer.arch.Connector`	Class that represents a connector between ports

Interfaces

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

Functions

expand all

Model Management

`loadModel`	Load architecture model
`open`	Open System Composer model
`openModel`	Open a System Composer architecture model
`getPort`	Get the port from a 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 a query
`close`	Close System Composer model

Model Building

`addComponent`	Add a component to the architecture
`addPort`	Add ports to architecture
`connect`	Connect pairs of components
`createModel`	Create a System Composer model
`createViewArchitecture`	Create a view
`destroy`	Remove and destroy a model element
`lookup`	Look up an architecture element

Variant Management

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

Interface Management

`systemcomposer.createDictionary`	Create data dictionary
`linkDictionary`	Link data dictionary to an architecture model
`unlinkDictionary`	Unlink dictionary from a model
`addInterface`	Create a named interface in an interface dictionary
`removeInterface`	Remove a named interface from an interface dictionary
`getInterface`	Get the object for a named interface in an interface dictionary
`getInterfaceNames`	Get the object for a named interface in an interface dictionary
`addElement`	Add a signal interface element
`removeElement`	Remove a signal interface element
`getElement`	Get the object a signal interface element
`destroy`	Remove and destroy a model element