setProperty

Set property value corresponding to stereotype applied to element

Since R2019a

Syntax

setProperty(element,propertyName,propertyValue,propertyUnits)

Description

setProperty(element,propertyName,propertyValue,propertyUnits) sets the value and units of the property specified in the propertyName argument. Set the property corresponding to an applied stereotype by qualified name "<profile>.<stereotype>.<property>".

Examples

Apply a Stereotype and Set Numeric Property Value

In this example, weight is a property of the stereotype sysComponent.

Create a model with a component called "Component".

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

Create a profile with a stereotype and properties, open the Profile Editor, then apply the profile to the model.

profile = systemcomposer.profile.Profile.createProfile("LatencyProfile");
latencybase = profile.addStereotype("LatencyBase");
latencybase.addProperty("latency",Type="double");
latencybase.addProperty("dataRate",Type="double",DefaultValue="10");
systemcomposer.profile.editor(profile)
model.applyProfile("LatencyProfile");

Apply the stereotype to the component, and set a new latency property.

applyStereotype(comp,"LatencyProfile.LatencyBase")
setProperty(comp,"LatencyProfile.LatencyBase.latency","500")

Apply a Stereotype and Set String Property Value

In this example, description is a property of the stereotype sysComponent.

Create a model with a component called Component.

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

Create a profile with a stereotype, then apply the profile to the model. Open the Profile Editor.

profile = systemcomposer.profile.Profile.createProfile("sysProfile");
base = profile.addStereotype("sysComponent");
base.addProperty("description",Type="string");
model.applyProfile("sysProfile");
systemcomposer.profile.editor

Apply the stereotype to the component, and set a new description property.

applyStereotype(comp,"sysProfile.sysComponent")
expression = sprintf("'%s'","component description")
setProperty(comp,"sysProfile.sysComponent.description",expression)

Set Property Value on Existing Component

Set the AutoProfile.System.Cost property on the FOB Locator System component.

Launch the keyless entry system project.

scKeylessEntrySystem

Load the model and find the FOB Locator System component.

model = systemcomposer.loadModel("KeylessEntryArchitecture");
comp = lookup(model,Path="KeylessEntryArchitecture/FOB Locator System");

Set the Cost property on the component.

setProperty(comp,"AutoProfile.System.Cost","200","USD")

Input Arguments

element — Architectural element

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

Architectural element, specified as a systemcomposer.arch.Architecture, systemcomposer.arch.Component, systemcomposer.arch.VariantComponent, systemcomposer.arch.ComponentPort, systemcomposer.arch.ArchitecturePort, systemcomposer.arch.Connector, systemcomposer.arch.PhysicalConnector, systemcomposer.arch.Function, systemcomposer.interface.DataInterface, systemcomposer.ValueType, systemcomposer.interface.PhysicalInterface, or systemcomposer.interface.ServiceInterface object.

propertyName — Name of property

character vector | string

Name of property, specified as a character vector or string in the form '<profile>.<stereotype>.<property>'.

Data Types: char | string

propertyValue — Value of property

character vector | string

Value of property, specified as a character vector or string. Specify string values in the form sprintf("'%s'",'<contents of string>'). For more information, see Apply a Stereotype and Set String Property Value.

Data Types: char | string

propertyUnits — Units of property

character vector | string

Units of property to interpret property values, specified as a character vector or string.

Data Types: char | 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.	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

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