getStereotypeProperties

Get stereotype property names on element

Since R2019a

Syntax

propNames = getStereotypeProperties(archElement)

Description

propNames = getStereotypeProperties(archElement) returns an array of stereotype property names on the specified architecture of an element.

Examples

Get Stereotype Properties

Create a profile, add a component stereotype, and add properties with default values.

profile = systemcomposer.profile.Profile.createProfile("LatencyProfile");
stereotype = addStereotype(profile,"electricalComponent",AppliesTo="Component");
stereotype.addProperty("latency",Type="double",DefaultValue="10");
stereotype.addProperty("mass",Type="double",DefaultValue="20");

Create a model with a component called Component.

model = systemcomposer.createModel("archModel");
systemcomposer.openModel("archModel");
arch = get(model,"Architecture");
comp = addComponent(arch,"Component");

Apply the profile to the model and apply the stereotype to the component. Open the Profile Editor.

model.applyProfile("LatencyProfile");
comp.applyStereotype("LatencyProfile.electricalComponent");
systemcomposer.profile.editor(profile)

Get stereotype properties on the architecture of the component.

properties = getStereotypeProperties(comp.Architecture)

properties =

    1×2 string array

    "LatencyProfile.electricalComponent.latency"    "LatencyProfile.electricalComponent.mass"

Input Arguments

archElement — Model element architecture

architecture object | architecture port object | connector object | physical connector object | allocation object | function object | data interface object | value type object | physical interface object | service interface object

Model element architecture, specified as a systemcomposer.arch.Architecture, systemcomposer.arch.ArchitecturePort, systemcomposer.arch.Connector, systemcomposer.arch.PhysicalConnector, systemcomposer.allocation.Allocation, systemcomposer.arch.Function, systemcomposer.interface.DataInterface, systemcomposer.ValueType, systemcomposer.interface.PhysicalInterface, or systemcomposer.interface.ServiceInterface object. You can also use the Architecture property of the systemcomposer.arch.Component object or the ArchitecturePort property of the systemcomposer.arch.ComponentPort object.

Example: arch

Example: comp.Architecture

Example: conn

Example: compPort.ArchitecturePort

Output Arguments

propNames — Property names

string array

Property names, returned as a string array, each in the form "<profile>.<stereotype>.<property>".

Data Types: string

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.	These 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	Stereotypes provide a mechanism to extend the core language elements and add domain-specific metadata.	Apply stereotypes to core element types. An element can have multiple stereotypes. Stereotype allow you to style different elements. Stereotypes provide elements with a common set of properties, such as mass, cost, and power.	Define Stereotypes and Perform Analysis Extend Architectural Design Using Stereotypes Define and Style Stereotypes in Profiles
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.	You can use profiles to create a domain of specialized 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.	Extend System Composer Language Elements Using Profiles Apply Stereotypes to Extend Model Elements

Term	Definition	Application	More Information
physical subsystem	A physical subsystem is a Simulink® subsystem with Simscape™ connections.	A physical subsystem with Simscape connections uses a physical network approach suited for simulating systems with real physical components and represents a mathematical model.	Implement Component Behavior Using Simscape
physical port	A physical port represents a Simscape physical modeling connector port called a Connection Port (Simscape).	Use physical ports to connect components in an architecture model or to enable physical systems in a Simulink subsystem.	Define Physical Ports on Component
physical connector	A physical connector can represent a nondirectional conserving connection of a specific physical domain. Connectors can also represent physical signals.	Use physical connectors to connect physical components that represent features of a system to simulate mathematically.	Architecture Model with Simscape Behavior for a DC Motor
physical interface	A physical interface defines the kind of information that flows through a physical port. The same interface can be assigned to multiple ports. A physical interface is a composite interface equivalent to a Simulink.ConnectionBus object that specifies any number of Simulink.ConnectionElement objects.	Use a physical interface to bundle physical elements to describe a physical model using at least one physical domain.	Specify Physical Interfaces on Ports
physical element	A physical element describes the decomposition of a physical interface. A physical element is equivalent to a Simulink.ConnectionElement object.	Define the Type of a physical element as a physical domain to enable use of that domain in a physical model.	Describe Component Behavior Using Simscape

Version History

Introduced in R2019a