Main Content

addProperty

Define custom property for stereotype

Description

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

example

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

Examples

collapse all

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

collapse all

Stereotype to which property is added, specified as a systemcomposer.profile.Stereotype object.

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

Data Types: char

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'Type', 'double'

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

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

Data Types: double

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

Example: setMinAndMax(property,min,max)

Data Types: double

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

Example: setMinAndMax(property,min,max)

Data Types: double

Units of the property value, specified as a character vector. 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.

Data Types: char

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

Data Types: char

Output Arguments

collapse all

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

More About

collapse all

Definitions

TermDefinitionApplicationMore Information
stereotypeA 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 the root level architecture, component architecture, connectors, ports, and interfaces of a model. Stereotypes provide model elements within the architecture a common set of property fields, such as mass, cost, and power.Define Profiles and Stereotypes
profileA profile is a package of stereotypes to create a self-consistent domain of model element types.Apply profiles to a model through the Profile Editor. You can store stereotypes for a project in one profile or in several. Profiles are stored in .xml files when they are saved.Use Stereotypes and Profiles
propertyA property is a field in a stereotype. For each model element the stereotype is applied to, specific property values are specified.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.Set Properties

Introduced in R2019a