batchApplyStereotype

Apply stereotype to all elements in architecture

Since R2019a

Syntax

batchApplyStereotype(arch,elementType,stereotype)

batchApplyStereotype(___,'Recurse',flag)

Description

batchApplyStereotype(arch,elementType,stereotype) applies the stereotype stereotype to all elements that match the element type elementType within the architecture arch.

batchApplyStereotype(___,'Recurse',flag) applies the stereotype stereotype to all elements that match the element type elementType within the architecture arch and recursively to its sub-architectures according to the value of flag.

Examples

Apply Stereotype to All Connectors

Create a profile, add a connector stereotype, and add a property with a default value. Open the Profile Editor to inspect the profile.

profile = systemcomposer.profile.Profile.createProfile("LatencyProfile");
stereotype = addStereotype(profile,"standardConn",AppliesTo="Connector");
stereotype.addProperty("latency",Type="double",DefaultValue="10");
systemcomposer.profile.editor(profile)

Create a model with three components, ports, and connectors between them. Improve the model layout.

modelName = "archModel";
arch = systemcomposer.createModel(modelName,true);
rootArch = get(arch,"Architecture");
names = ["Component1","Component2","Component3"];
newComponents = addComponent(rootArch,names);
outPort1 = addPort(newComponents(1).Architecture,"testSig1","out"); 
inPort1 = addPort(newComponents(2).Architecture,"testSig1","in");
outPort2 = addPort(newComponents(2).Architecture,"testSig2","out"); 
inPort2 = addPort(newComponents(3).Architecture,"testSig2","in");
conn1 = connect(newComponents(1),newComponents(2));
conn2 = connect(newComponents(2),newComponents(3));
Simulink.BlockDiagram.arrangeSystem(modelName)

Apply the profile to the model.

arch.applyProfile("LatencyProfile");

Apply the connector stereotype to all the connectors in the architecture rootArch. Inspect the connectors in the Property Inspector to confirm the applied stereotypes.

batchApplyStereotype(rootArch,"Connector","LatencyProfile.standardConn")

Input Arguments

arch — Architecture

architecture object

Architecture, specified as a systemcomposer.arch.Architecture object.

elementType — Element type

"Component" | "Port" | "Connector" | "Interface" | "Function"

Element type, specified as "Component", "Port", "Connector", "Interface", or "Function". The element type "Function" is only available for software architectures.

Data Types: char | string

stereotype — Stereotype to apply

character vector | string

Stereotype to apply, specified as a character vector or string in the form "<profile>.<stereotype>". This stereotype must be applicable for the element type.

Data Types: char | string

flag — Whether to apply stereotype recursively

false or 0 (default) | true or 1

Whether to apply stereotype recursively, specified as a logical. If flag is 1 (true), the stereotype is applied to the elements in the architecture and its sub-architectures.

Data Types: logical

More About

Definitions

Term	Definition	Application	More Information
architecture	A System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally.	Different types of architectures describe different aspects of systems. You can use views to visualize a subset of components in an architecture. You can define parameters on the architecture level using the Parameter Editor.	Compose Architectures Visually Author Parameters in System Composer Using Parameter Editor
model	A System Composer model is the file that contains architectural information, including components, ports, connectors, interfaces, and behaviors.	Perform operations on a model: Extract the root-level architecture contained in the model. Apply profiles. Link interface data dictionaries. Generate instances from model architecture. A System Composer model is stored as an SLX file.	Create Architecture Model with Interfaces and Requirement Links
component	A component is a nontrivial, nearly independent, and replaceable part of a system that fulfills a clear function in the context of an architecture. A component defines an architectural element, such as a function, a system, hardware, software, or other conceptual entity. A component can also be a subsystem or subfunction.	Represented as a block, a component is a part of an architecture model that can be separated into reusable artifacts. Transfer information between components with: Port interfaces using the Interface Editor Parameters using the Parameter Editor	Components
port	A port is a node on a component or architecture that represents a point of interaction with its environment. A port permits the flow of information to and from other components or systems.	There are different types of ports: Component ports are interaction points on the component to other components. Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model.	Ports
connector	Connectors are lines that provide connections between ports. Connectors describe how information flows between components or architectures.	A connector allows two components to interact without defining the nature of the interaction. Set an interface on a port to define how the components interact.	Connections

Term	Definition	Application	More Information
stereotype	A stereotype is a custom extension of the modeling language. Stereotypes provide a mechanism to extend the architecture language elements by adding domain-specific metadata.	Apply stereotypes to model elements such as root-level architecture, component architecture, connectors, ports, data interfaces, value types, functions, requirements, and links. Functions only apply to software architectures. You must have a Requirements Toolbox™ license to apply stereotypes to requirements and links. A model element can have multiple stereotypes. Stereotypes provide model elements with a common set of property fields, such as mass, cost, and power.	Extend Architectural Design Using Stereotypes
property	A property is a field in a stereotype. You can specify property values for each element to which the stereotype is applied.	Use properties to store quantitative characteristics, such as weight or speed, that are associated with a model element. Properties can also be descriptive or represent a status. You can view and edit the properties of each element in the architecture model using the Property Inspector.	Set Properties Add Properties with Stereotypes Set Properties for Analysis
profile	A profile is a package of stereotypes that you can use to create a self-consistent domain of element types.	Author profiles and apply profiles to a model using the Profile Editor. You can store stereotypes for a project in one or several profiles. When you save profiles, they are stored in XML files.	Define Profiles and Stereotypes Use Stereotypes and Profiles

Version History

Introduced in R2019a