systemcomposer.view.View

Architecture view

Since R2021a

Description

A View object is used to manage architecture views for a System Composer™ model.

Creation

Create a view using the createView function.

objView = createView(objModel)

Properties

expand all

`Name` — Name of view
string

Name of view, specified as a string.

Example: "NewView"

Data Types: string

`Root` — Root element group
element group object

Root element group that defines view, specified as a systemcomposer.view.ElementGroup object.

`Model` — Architecture model
model object

Architecture model where view belongs, specified as a systemcomposer.arch.Model object.

`Select` — Selection query
constraint object

Selection query associated with view, specified as a systemcomposer.query.Constraint object.

`GroupBy` — Grouping criteria
string array of properties

Grouping criteria, specified as a string array of properties in the form "<profile>.<stereotype>.<property>".

Example: ["AutoProfile.MechanicalComponent.mass","AutoProfile.MechanicalComponent.cost"]

`Color` — Color of view
string

Color of view, specified as a string. The color can be the name "blue", "black", or "green", or it can be an RGB value encoded in a hexadecimal string: "#FF00FF" or "#DDDDDD". An invalid color results in an error.

`Description` — Description of view
string

Description of view, specified as a string.

Data Types: string

`IncludeReferenceModels` — Whether to include referenced models
`1` (`true`) | `0` (`false`)

Whether to include referenced models, specified as 1 (true) or 0 (false).

Example: included = get(objView,'IncludeReferenceModels')

Data Types: logical

`UUID` — Universal unique identifier
character vector

Universal unique identifier, specified as a character vector.

Example: '91d5de2c-b14c-4c76-a5d6-5dd0037c52df'

Data Types: char

Object Functions

`modifyQuery`	Modify architecture view query and property groupings
`runQuery`	Re-run architecture view query on model
`removeQuery`	Remove architecture view query
`destroy`	Remove model element

Examples

collapse all

Create Architecture Views in System Composer with Keyless Entry System

Open Live Script

Use a keyless entry system architecture model to programmatically create views.

Import the namespace with queries.

import systemcomposer.query.*

Open the Simulink® project file for the keyless entry system.

openProject("scKeylessEntrySystem");

Load the example model into System Composer™.

model = systemcomposer.loadModel("KeylessEntryArchitecture");

Hardware Component Review Status View

Create a view that selects all hardware components in the architecture model and groups them using the ReviewStatus property.

1. Construct a query to select all hardware components.

hwCompQuery = HasStereotype(IsStereotypeDerivedFrom("AutoProfile.HardwareComponent"));

2. Use the query to create a view.

model.createView("Hardware Component Review Status",...
 Select=hwCompQuery,...
 GroupBy={'AutoProfile.BaseComponent.ReviewStatus'},...
 IncludeReferenceModels=true,...
 Color="purple");

3. To open the Architecture Views Gallery the Modeling section, click Architecture Views.

model.openViews

Hardware component review status component diagram view.

FOB Locater System Supplier View

Create a view with components from the FOB Locater System and group them using existing and new view components for the suppliers. In this example, you will use element groups, groupings of components in a view, to programmatically populate a view.

1. Create a view architecture.

fobSupplierView = model.createView("FOB Locater System Supplier Breakdown",...
    Color="lightblue");

2. Add a subgroup called Supplier D. Add the FOB Locater Module to the view element subgroup.

supplierD = fobSupplierView.Root.createSubGroup("Supplier D");
supplierD.addElement("KeylessEntryArchitecture/FOB Locater System/FOB Locater Module");

3. Create a new subgroup for Supplier A.

supplierA = fobSupplierView.Root.createSubGroup("Supplier A");

4. Add each of the FOB Receivers to the view element subgroup.

FOBLocaterSystem = model.lookup("Path","KeylessEntryArchitecture/FOB Locater System");

Find all the components which contain the name Receiver.

receiverCompPaths = model.find(...
    contains(Property("Name"),"Receiver"),...
    FOBLocaterSystem.Architecture);

supplierA.addElement(receiverCompPaths)

FOB locater system supplier view component diagram.

More About

expand all

Definitions

Term	Definition	Application	More Information
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.	Create Custom Views Using Architecture Views Gallery Modeling System Architecture of Keyless Entry System
element group	An element group is a grouping of components in a view.	Use element groups to programmatically populate a view.	Create Architecture Views Interactively Create Architecture Views Programmatically
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.	Find Elements in Model Using Queries
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.	Inspect Components in Custom Architecture Views
hierarchy diagram	You can visualize a hierarchy diagram as a view with components, ports, reference types, component stereotypes, and stereotype properties.	System Composer has 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.	Display Component Hierarchy and Architecture Hierarchy Using Views

Version History

Introduced in R2021a

systemcomposer.view.View

Description

Creation

Properties

`Name` — Name of view
string

`Root` — Root element group
element group object

`Model` — Architecture model
model object

`Select` — Selection query
constraint object

`GroupBy` — Grouping criteria
string array of properties

`Color` — Color of view
string

`Description` — Description of view
string

`IncludeReferenceModels` — Whether to include referenced models
`1` (`true`) | `0` (`false`)

`UUID` — Universal unique identifier
character vector

Object Functions

Examples

Create Architecture Views in System Composer with Keyless Entry System

More About

Definitions

Version History

See Also

Tools

Functions

Objects

Topics

systemcomposer.view.View

Description

Creation

Properties

Name — Name of view string

Root — Root element group element group object

Model — Architecture model model object

Select — Selection query constraint object

GroupBy — Grouping criteria string array of properties

Color — Color of view string

Description — Description of view string

IncludeReferenceModels — Whether to include referenced models 1 (true) | 0 (false)

UUID — Universal unique identifier character vector

Object Functions

Examples

Create Architecture Views in System Composer with Keyless Entry System

More About

Definitions

Version History

See Also

Tools

Functions

Objects

Topics

`Name` — Name of view
string

`Root` — Root element group
element group object

`Model` — Architecture model
model object

`Select` — Selection query
constraint object

`GroupBy` — Grouping criteria
string array of properties

`Color` — Color of view
string

`Description` — Description of view
string

`IncludeReferenceModels` — Whether to include referenced models
`1` (`true`) | `0` (`false`)

`UUID` — Universal unique identifier
character vector