addProperty - Define custom property for stereotype - MATLAB (original) (raw)

Define custom property for stereotype

Syntax

Description

[property](#mw%5Fa5433de4-8177-4001-bce8-d5748e6ad88e) = addProperty([stereotype](#mw%5Fdcdbf083-3263-4890-8702-502181ca3ca5%5Fsep%5Fmw%5F7965c94c-9a05-44d8-b9cb-6969fea14317),[name](#mw%5F4bbc53a0-fb9f-4f38-9412-b088dfc217f5)) returns a new property definition with name that is contained in stereotype.

To remove a property, use the removeProperty function.

example

[property](#mw%5Fa5433de4-8177-4001-bce8-d5748e6ad88e) = addProperty([stereotype](#mw%5Fdcdbf083-3263-4890-8702-502181ca3ca5%5Fsep%5Fmw%5F7965c94c-9a05-44d8-b9cb-6969fea14317),[name](#mw%5F4bbc53a0-fb9f-4f38-9412-b088dfc217f5),[Name=Value](#namevaluepairarguments)) returns a property definition that is configured with specified name-value arguments.

example

Examples

collapse all

Add a component stereotype and add a VoltageRating property.

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

Add a component stereotype and add a Status property with the default value "active".

profile = systemcomposer.profile.Profile.createProfile("myProfile"); stereotype = addStereotype(profile,"electricalComponent",AppliesTo="Component"); property = addProperty(stereotype,"Status",type="string",DefaultValue='"active"');

Add a component stereotype.

profile = systemcomposer.profile.Profile.createProfile("myProfile"); stereotype = addStereotype(profile,"DataConnector",AppliesTo="Connector");

In a separate file, create a ConnectorType enumeration class.

classdef ConnectorType < Simulink.IntEnumType enumeration USB(0) Ethernet(1) RS232(2) end end

Add a TypeOfConnection property with Type set to newly created ConnectorType data type.

property = addProperty(stereotype,"TypeOfConnection",type="ConnectorType");

Input Arguments

collapse all

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

Data Types: char | string

Name-Value Arguments

collapse all

Specify optional pairs of arguments asName1=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 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 of property, specified as a positive integer array. Empty implies no restriction.

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

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)

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

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)

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

Data Types: double

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, seeUnit Consistency Checking and Propagation.

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

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

More About

Version History

Introduced in R2019a

See Also

Tools

Blocks

Objects

Functions

Topics