Architecture Views Gallery

Create and manage architecture views and sequence diagrams

Since R2019b

Description

The Architecture Views Gallery allows you to create filtered and freeform architecture views and author sequence diagrams.

Use the View Configurations options to specify component and port filters for views, and to specify grouping criteria. Click and drag components from the Model Components browser to specify the contents of a freeform view. Select views from the View Browser and use the Component Properties options to specify a name, color, and description for a view.

Switch between these types of view diagrams:

Component Diagram — Display components, ports, and connectors based on how the model is structured.
Component Hierarchy — Display components in tree form with parents above children. In a component hierarchy view, each referenced model is represented as many times as it is used.
Architecture Hierarchy — Display unique component architecture types and their relationships using composition connections. In an architecture hierarchy view, each referenced model is represented only once.
Class Diagram — Display unique architecture types of the software components optionally with software methods and properties, only available for software architecture models.

You can also link and edit requirements for views through the Architecture Views Gallery.

To create a new sequence diagram, click New > Sequence Diagram. Select existing sequence diagrams from the View Browser and use the Sequence Diagram Properties options to specify a name for the sequence diagram. To add a lifeline, click and drag from the Model Components browser. Alternatively, select Component > Add Lifeline from the menu and click the down arrow to select a component to be represented by the lifeline. Click and drag from the vertical dotted lines coming down from one lifeline to another to author a message that represents a connection between two ports. To confirm the consistency of the sequence diagram, click Check Consistency. Then, either push changes to the architecture by clicking Create in Architecture, or pull changes in from the architecture to the sequence diagram by clicking Repair.

Open the Architecture Views Gallery

System Composer™ toolstrip: Navigate to Modeling > Architecture Views.
System Composer toolstrip: Navigate to Modeling > Sequence Diagram.
MATLAB^® Command Window: Enter openViews with a systemcomposer.arch.Model object as the input argument.

Examples

Parameters

expand all

`New` — Create new view or sequence diagram
button

Create a new view by default by clicking New, or click the drop-down arrow to choose New > View. Create a new sequence diagram by selecting New > Sequence Diagram.

`Save` — Save views, sequence diagrams, and model
button

Save all views, sequence diagrams, and the architecture model.

`Delete` — Delete currently selected diagram
button

Delete the currently selected view or sequence diagram.

`Run Query` — Refresh currently selected view
button

Refresh the currently selected view with changes in the composition and rerun the corresponding filter, if it exists.

`Add` — Add selected component to view
button

Add the selected component in the Model Components browser to the current view diagram.

If the view is a filtered view, a prompt appears to convert the filtered view to a freeform view.

`Remove` — Remove selected component from view
button

Remove a selected component in a view from the current view diagram.

If the view is a filtered view, a prompt appears to convert the filtered view to a freeform view.

`Group` — Group selected components in view
button

Group the selected components in a view.

`Ungroup` — Ungroup selected components in view
button

Ungroup the selected components in a view.

`Pivot` — Pivot to other diagrams in which selected component or lifeline appears
button

Pivot to other diagrams in which selected component or lifeline appears. Use the drop-down list to select the view diagram or sequence diagram to which to pivot. For more information, see Pivot Between Lifelines and Components in Views Gallery.

`Focus` — Focus on selected component
button

Focus on the selected component to make it the new root of the diagram in the view.

`Display Depth` — Modify number of levels of hierarchy to display
Deep (default) | Shallow

Modify the number of levels of hierarchy to display. Deep includes more levels and Shallow includes fewer levels.

`Export` — Export to image
button

Export the currently selected diagram as an image. View diagrams can be saved as PDF files. Sequence diagrams can be saved as PDF files or image files.

`Add Lifeline` — Insert new lifeline into sequence diagram
button

Create a new lifeline after the selected lifeline by default by clicking Add Lifeline, or click the drop-down arrow to choose Add Lifeline > Insert After. Create a new lifeline before the selected lifeline by selecting Add Lifeline > Insert Before. Create a new lifeline nested under the selected lifeline by selecting Add Lifeline > Add Child.

`Add Operand` — Insert new operand into sequence diagram
button

Create a new operand after the selected operand by default by clicking Add Operand, or click the drop-down arrow to choose Add Operand > Insert After. Create a new operand before the selected operand by selecting Add Operand > Insert Before.

`Check Consistency` — Check whether elements in sequence diagram are consistent with architecture model
button

Check that all the elements in the current sequence diagram are consistent with the architecture model. If any of the elements in the sequence diagram are inconsistent, clicking Check Consistency highlights those elements in yellow.

`Architecture Element` — Specify different associated element in architecture model for selected elements in sequence diagram
component | port

Specify a different associated element in the architecture model for the selected elements in the sequence diagram.

`Create in Architecture` — Create elements in architecture model
button

Create elements in the architecture model for each of the selected inconsistent elements in the sequence diagram.

`Repair` — Update selected elements so sequence diagram is consistent with architecture model
button

Update the selected inconsistent elements in the sequence diagram so the sequence diagram is consistent with the architecture model.

`Run` — Run simulation
button

Run model simulation and verify that the model simulation results match the interactions within the sequence diagrams.

`Pause` — Pause simulation
button

Pause model simulation and sequence diagram simulation.

`Stop` — Stop simulation
button

Stop model simulation and sequence diagram simulation.

`Continue` — Continue simulation
button

Continue model simulation until the end and verify that the model simulation results match the interactions within the sequence diagrams.

`Next Message` — Continue until next message is hit
button

Continue until next message is hit and verify that the model simulation results match the interactions within the sequence diagrams.

`Clear Results` — Clear simulation results
button

Clear simulation results and remove green check marks or red warning marks on the sequence diagram.

Programmatic Use

expand all

`openViews(model)`

openViews(model) opens the Architecture Views Gallery from the MATLAB Command Window.

More About

expand all

View

A view shows a customizable subset of elements in a model. Views can be filtered based on stereotypes or names of components, ports, and interfaces, along with the name, type, or units of an interface element. Create views by adding elements manually. Views create a simplified way to work with complex architectures by focusing on certain parts of the architectural design.

You can use different types of views to represent the system. Switch between a component diagram, component hierarchy, or architecture hierarchy. For software architectures, you can switch to a class diagram view.

Element Group

An element group is a grouping of components in a view.

Use element groups to programmatically populate a view.

Query

A query is a specification that describes certain constraints or criteria to be satisfied by model elements.

Use queries to search elements with constraint criteria and to filter views.

Component Diagram

A component diagram represents a view with components, ports, and connectors based on how the model is structured.

Component diagrams allow you to programmatically or manually add and remove components from the view.

Hierarchy Diagram

You can visualize a hierarchy diagram as a view with components, ports, reference types, component stereotypes, and stereotype properties.

There are two types of hierarchy diagrams:

Component hierarchy diagrams display components in tree form with parents above children. In a component hierarchy view, each referenced model is represented as many times as it is used.
Architecture hierarchy diagrams display unique component architecture types and their relationships using composition connections. In an architecture hierarchy view, each referenced model is represented only once.

Class Diagram

A class diagram is a graphical representation of a static structural model that displays unique architecture types of the software components optionally with software methods and properties.

Class diagrams capture one instance of each referenced model and show relationships between them. Any component diagram view can be optionally represented as a class diagram for a software architecture model.

Sequence Diagram

A sequence diagram represents the expected interaction between structural elements of an architecture as a sequence of message exchanges.

Use sequence diagrams to describe how the parts of a system interact.

Lifeline

A lifeline is represented by a head and a timeline that proceeds down a vertical dotted line.

The head of a lifeline represents a component in an architecture model.

Message

A message sends information from one lifeline to another. Messages are specified with a message label.

A message label has a trigger and a constraint. A trigger determines whether the message occurs. A constraint determines whether the message is valid.

Annotation

An annotation describes the elements of a sequence diagram.

Use annotations to provide detailed explanations of elements or workflows captured by sequence diagrams.

Fragment

A fragment indicates how a group of messages within it execute or interact.

A fragment is used to model complex sequences, such as alternatives, in a sequence diagram.

Operand

An operand is a region in a fragment. Fragments have one or more operands depending on the kind of fragment. Operands can contain messages and additional fragments.

Each operand can include a constraint to specify whether the messages inside the operand execute. You can express the precondition of an operand as a MATLAB Boolean expression using the input signal of any lifeline.

Version History

Introduced in R2019b

Architecture Views Gallery

Description

Open the Architecture Views Gallery

Examples

Parameters

New — Create new view or sequence diagram button

Save — Save views, sequence diagrams, and model button

Delete — Delete currently selected diagram button

Run Query — Refresh currently selected view button

Add — Add selected component to view button

Remove — Remove selected component from view button

Group — Group selected components in view button

Ungroup — Ungroup selected components in view button

Pivot — Pivot to other diagrams in which selected component or lifeline appears button

Focus — Focus on selected component button

Display Depth — Modify number of levels of hierarchy to display Deep (default) | Shallow

Export — Export to image button

Add Lifeline — Insert new lifeline into sequence diagram button

Add Operand — Insert new operand into sequence diagram button

Check Consistency — Check whether elements in sequence diagram are consistent with architecture model button

Architecture Element — Specify different associated element in architecture model for selected elements in sequence diagram component | port

Create in Architecture — Create elements in architecture model button

Repair — Update selected elements so sequence diagram is consistent with architecture model button

Run — Run simulation button

Pause — Pause simulation button

Stop — Stop simulation button

Continue — Continue simulation button

Next Message — Continue until next message is hit button

Clear Results — Clear simulation results button

Programmatic Use

openViews(model)

More About

View

Element Group

Query

Component Diagram

Hierarchy Diagram

Class Diagram

Sequence Diagram

Lifeline

Message

Annotation

Fragment

Operand

Version History

See Also

Functions

Objects

WeChat

`New` — Create new view or sequence diagram
button

`Save` — Save views, sequence diagrams, and model
button

`Delete` — Delete currently selected diagram
button

`Run Query` — Refresh currently selected view
button

`Add` — Add selected component to view
button

`Remove` — Remove selected component from view
button

`Group` — Group selected components in view
button

`Ungroup` — Ungroup selected components in view
button

`Pivot` — Pivot to other diagrams in which selected component or lifeline appears
button

`Focus` — Focus on selected component
button

`Display Depth` — Modify number of levels of hierarchy to display
Deep (default) | Shallow

`Export` — Export to image
button

`Add Lifeline` — Insert new lifeline into sequence diagram
button

`Add Operand` — Insert new operand into sequence diagram
button

`Check Consistency` — Check whether elements in sequence diagram are consistent with architecture model
button

`Architecture Element` — Specify different associated element in architecture model for selected elements in sequence diagram
component | port

`Create in Architecture` — Create elements in architecture model
button

`Repair` — Update selected elements so sequence diagram is consistent with architecture model
button

`Run` — Run simulation
button

`Pause` — Pause simulation
button

`Stop` — Stop simulation
button

`Continue` — Continue simulation
button

`Next Message` — Continue until next message is hit
button

`Clear Results` — Clear simulation results
button

`openViews(model)`