addProperty

Define custom property for stereotype

Since R2019a

Syntax

property = addProperty(stereotype,name)

property = addProperty(stereotype,name,Name=Value)

Description

property = addProperty(stereotype,name) returns a new property definition with name that is contained in stereotype.

To remove a property, use the removeProperty function.

property = addProperty(stereotype,name,Name=Value) returns a property definition that is configured with specified property values.

Examples

Add Property

Add a component stereotype and add a VoltageRating property with value 5.

profile = systemcomposer.profile.Profile.createProfile("myProfile");
stereotype = addStereotype(profile,"electricalComponent",AppliesTo="Component");
property = addProperty(stereotype,"VoltageRating",DefaultValue="5");

Input Arguments

stereotype — Stereotype

stereotype object

Stereotype, specified as a systemcomposer.profile.Stereotype object.

name — Name of property

character vector | string

Name of property unique within the stereotype, specified as a character vector or string.

Data Types: char | string

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: addProperty(stereotype,"Amount",Type="double")

Type — Property data type

double (default) | single | int64 | int32 | int16 | int8 | uint64 | uint32 | uint8 | boolean | string | enumeration class name

Type of this property. One of valid data types or the name of a MATLAB class that defines an enumeration. For more information, see Use Enumerated Data in Simulink Models.

Example: addProperty(stereotype,"Color",Type="BasicColors")

Data Types: char | string

Dimensions — Dimensions of property

positive integer array

Dimensions of property, specified as a positive integer array. Empty implies no restriction.

Example: addProperty(stereotype,"Amount",Dimensions=2)

Data Types: double

Min — Minimum value

numeric

Optional minimum value of this property. To set both 'Min' and 'Max' together, use the setMinAndMax method.

Example: setMinAndMax(property,min,max)

Example: addProperty(stereotype,"Amount",Min="0")

Data Types: double

Max — Maximum value

numeric

Optional maximum value of this property. To set both 'Min' and 'Max' together, use the setMinAndMax method.

Example: setMinAndMax(property,min,max)

Example: addProperty(stereotype,"Amount",Max="100")

Data Types: double

Units — Property units

character vector | string

Units of the property value, specified as a character vector or string. If specified, all values of this property on model elements are checked for consistency with these units according to Simulink unit checking rules. For more information, see Unit Consistency Checking and Propagation.

Example: addProperty(stereotype,"Amount",Units="kg")

Data Types: char | string

DefaultValue — Default value

character vector | string

Default value of this property, specified as a character vector or string that can be evaluated depending on the Type.

Data Types: char | string

Output Arguments

property — Created property

property object

Created property, returned as a systemcomposer.profile.Property object.

More About

Definitions

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

Version History

Introduced in R2019a