Architecture Views Gallery

Create and manage views and sequence diagrams

Description

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

Use the View Configurations options to specify filters for views, and to specify grouping criteria. Click and drag components from the Model Components browser to add or remove components from your view. Select views from the View Browser and use the View 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 and sequence diagrams through the Architecture Views Gallery.

In R2024b: You can add, edit, and delete components, ports, and connectors in your System Composer™ model from the component diagram view. For more information, see Author Architecture Models Through Component Diagram Views.

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

• Create Custom Views Using Architecture Views Gallery
• Class Diagram View of Software Architectures
• Modeling System Architecture of Keyless Entry System
• Use Interface Editor in Views
• Group Ports in Component Diagram Views
• Pivot Between Lifelines and Components in Views Gallery
• Describe System Behavior Using Sequence Diagrams
• Simulate Sequence Diagrams for Traffic Light Example

Parameters

View

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.

Zoom In — Zoom in to the view

button

Zoom in to the view with Ctrl+=.

Zoom Out — Zoom out of the view

button

Zoom out of the view with Ctrl+Minus.

Show the model at 1:1 ratio — Resize model proportionately

button

Resize model proportionately with Ctrl+0.

Fit model to screen — Resize model to fit to screen

button

Resize model to fit to screen with Space.

Pan — Pan model with hand icon

button

Pan model with hand icon.

Remove peripheral white space in View — Remove white space in border

button

Remove white space in border.

Automatically Layout Components in View — Clean up component layout

button

Clean up component layout with Ctrl+Shift+A.

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 composition, view, 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.

Group Ports — Automatically group ports on components in view

button

Group ports connected to a common set of components to simplify your diagram. For more information, see Group Ports in Component Diagram Views.

Interface Editor — Launch Interface Editor tool

button

Launch the Interface Editor tool docked in the Architecture Views Gallery tool.

Export — Export currently selected diagram

button

Export currently selected diagram. View diagrams and sequence diagrams can be saved as PDF files or SVG files.

Add Component Filter — Add or delete component filters

Add Component Filter (default) | Select All Components | Add Custom Component Filter | Clear All Component Filters

Add component filters to your view. Add Component Filter allows you to select a query for the view filter. Select All Components selects all components in your model to be included in the view. Add Custom Component Filter shows a text box to manually enter a custom query using the systemcomposer.query.Constraint objects. Clear All Component Filters clears your component filters.

Add Port Filter — Add or delete port filters

Add Port Filter (default) | Exclude All Ports | Hide Unconnected Ports | Hide Connectors | Add Custom Port Filter | Clear All Port Filters

Add port filters to your view. Add Port Filter allows you to select a query for the view filter. Exclude All Ports hides all ports in the view. Hide Unconnected Ports hides unconnected ports in the view. Hide Connectors hides connectors in the view. Add Custom Port Filter shows a text box to manually enter a custom query using the systemcomposer.query.Constraint objects. Clear All Port Filters clears your port filters.

Apply — Apply filter changes to view

button

Applies all new changes to filters to your view.

Revert — Revert filter changes from view

button

Reverts all new changes to filters from your view.

Auto Apply — Condition for applying filtering changes to view instantaneously

off (default) | on

Condition for applying filtering changes to view instantaneously. If enabled, every new filter change you make is auto-applied to your view in real time.

Sequence Diagram

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.

Duration Constraint — Insert new duration constraint into sequence diagram

button

Create a new duration constraint by pressing Shift, clicking two message events with your cursor, and selecting Duration Constraint.

Fit to Content — Resize element to fit content

button

Resize lifelines and messages to fit content.

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 sequence diagram — 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

openViews(model) opens the Architecture Views Gallery from the MATLAB Command Window. The model input argument is a systemcomposer.arch.Model object.

open(interaction) opens the specified sequence diagram in the Architecture Views Gallery from the MATLAB Command Window. The interaction input argument is a systemcomposer.interaction.Interaction object that represents a sequence diagram.

More About

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. A viewpoint represents a stakeholder perspective that specifies the contents of the 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. 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. A component diagram view can be optionally represented as a class diagram for a software architecture model.

Sequence Diagram

A sequence diagram is a visual representation of an interaction. Use sequence diagrams to visually specify how each part of a system should interact.

Lifeline

A lifeline represents an instance of a component as a participant of an interaction. A lifeline corresponds to a component in an architecture.

Message

A message represents communication between two lifelines. Messages have labels to specify the expected condition for the message to occur. A message label has a trigger, an optional guard, and an optional constraint where a trigger represents the identifying event for this message, a guard represents an additional condition to determine whether the message occurs, and a constraint is an expression that is expected to be true when this message occurs.

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 encloses a group of lifelines and messages within an interaction to allow for the specification of more complex patterns of interaction. A fragment defines the type of ordering logic such as looping and alternatives. Fragments can have one or more operands.

Operand

An operand is a region in a fragment, or group of messages. The condition of an operand specifies whether the messages inside the operand execute. The condition of an operand can specify constraints on the input signal of a lifeline as a MATLAB Boolean expression.

Duration Constraint

A duration constraint defines a constraint on elapsed time between a start and an end occurrence. Use duration constraints to explicitly express a constraint on the duration between a start occurrence and an end occurrence.

Version History

Introduced in R2019b