systemcomposer.profile.Stereotype
Stereotype in profile
Description
A Stereotype
object represents stereotypes in a profile for a
System Composer™ model.
Creation
Add a stereotype to a profile using the addStereotype
function.
profile = systemcomposer.profile.Profile.createProfile("profileName"); addStereotype(profile,"stereotypeName");
Properties
Name
— Name of stereotype
string
Name of stereotype, specified as a string. This property must be a valid MATLAB® identifier.
Example: "HardwareComponent"
Data Types: string
Description
— Description text for stereotype
string
Description text for stereotype, specified as a string.
Data Types: string
Icon
— Icon name for stereotype
string
Icon name for stereotype, specified as one of the following options:
"default"
"application"
"channel"
"controller"
"database"
"devicedriver"
"memory"
"network"
"plant"
"sensor"
"subsystem"
"transmitter"
This property is only valid for component stereotypes. The element a stereotype applies to is set with the AppliesTo
property.
Data Types: string
Parent
— Stereotype from which stereotype inherits properties
stereotype object
Stereotype from which stereotype inherits properties, specified as a systemcomposer.profile.Stereotype
object.
AppliesTo
— Element type to which stereotype can be applied
""
(default) | "Component"
| "Port"
| "Connector"
| "Interface"
| "Allocation"
| "Function"
| "Requirement"
| "Link"
Element type to which stereotype can be applied, specified as one of these options:
""
to apply stereotype to all element types."Component"
."Port"
."Connector"
."Interface"
."Allocation"
. For more information, see Create and Manage Allocations Interactively."Function"
, which is only available for software architectures. For more information, see Apply Stereotypes to Functions of Software Architectures."Requirement"
, to be used with a Requirements Toolbox™ license. For more information, see Customize Requirements and Links by Using Stereotypes (Requirements Toolbox)."Link"
, to be used with a Requirements Toolbox license.
Data Types: string
Abstract
— Whether stereotype is abstract
1
(true
) | 0
(false
)
Whether stereotype is abstract, specified as 1
(true
) or 0
(false
). If true
,
then the stereotype cannot be directly applied on model elements, but instead serves as
a parent for other stereotypes.
Data Types: logical
FullyQualifiedName
— Qualified name of stereotype
character vector
Qualified name of stereotype, specified as a character vector in the form
'<profile>.<stereotype>'
.
Data Types: char
ComponentHeaderColor
— Component header color
1x3 uint32
row vector
Component header color, specified as a 1x3 uint32
row vector in
the form [Red Green Blue]
.
This property is only valid for component stereotypes. The element a stereotype
applies to is set with the AppliesTo
property.
Example: [206 232 246]
Data Types: uint32
ConnectorLineColor
— Connector line color
1x3 uint32
row vector
Connector line color, specified as a 1x3 uint32
row vector in the
form [Red Green Blue]
.
This property is only valid for connector, port, and interface stereotypes. The
element a stereotype applies to is set with the AppliesTo
property.
Example: [206 232 246]
Data Types: uint32
ConnectorLineStyle
— Connector line style
character vector | string
Connector line style, specified as a character vector or string. Options include:
"Default"
"Dot"
"Dash"
"Dash Dot"
"Dash Dot Dot"
This property is only valid for connector, port, and interface stereotypes. The
element a stereotype applies to is set with the AppliesTo
property.
Data Types: char
| string
Profile
— Profile of stereotype
profile object
Profile of stereotype from which stereotype inherits properties, specified as a
systemcomposer.profile.Profile
object.
Properties
— Properties
cell array of character vectors
Properties contained in stereotype and inherited from the stereotype base hierarchy, specified as a cell array of character vectors.
Data Types: char
OwnedProperties
— Owned properties
cell array of character vectors | array of strings | array of property objects
Owned properties contained in stereotype, specified as a cell array of character
vectors, an array of strings, or an array of systemcomposer.profile.Property
objects. The owned properties do not include
properties inherited from the stereotype base hierarchy.
Data Types: char
| string
Object Functions
addProperty | Define custom property for stereotype |
removeProperty | Remove property from stereotype |
getDefaultElementStereotype | Get default stereotype for elements |
setDefaultElementStereotype | Set default stereotype for elements |
find | Find stereotype by name |
destroy | Remove model element |
Examples
Build Architecture Models Programmatically
Build an architecture model programmatically using System Composer™.
To build a model, add a data dictionary with data interfaces, data elements, a value type, and a physical interface, then add components, ports, and connections. Create a profile with stereotypes and properties and then apply those stereotypes to model elements. Assign an owned interface to a port. After the model is built, you can create custom views to focus on specific considerations. You can also query the model to collect different model elements according to criteria you specify.
Add Components, Ports, Connections, and Interfaces
Create a model and extract its architecture.
model = systemcomposer.createModel("mobileRobotAPI");
arch = model.Architecture;
Create an interface data dictionary and add a data interface. Add a data element to the data interface. Add a value type to the interface data dictionary. Assign the type of the data element to the value type. Add a physical interface and physical element with a physical domain type. Link the data dictionary to the model.
dictionary = systemcomposer.createDictionary("SensorInterfaces.sldd"); interface = dictionary.addInterface("GPSInterface"); element = interface.addElement("SignalStrength"); valueType = dictionary.addValueType("SignalStrengthType",Units="dB", ... Description="GPS Signal Strength"); element.setType(valueType); physicalInterface = dictionary.addPhysicalInterface("PhysicalInterface"); physicalElement = addElement(physicalInterface,"ElectricalElement", ... Type="electrical.electrical"); linkDictionary(model,"SensorInterfaces.sldd");
Save the changes to the interface data dictionary.
dictionary.save
Save the model.
model.save
Open the model.
systemcomposer.openModel("mobileRobotAPI");
View the interfaces in the Interface Editor.
Add components, ports, and connections. Set the physical interface to the physical ports, which you connect later.
componentSensor = addComponent(arch,"Sensor"); sensorPorts = addPort(componentSensor.Architecture,{'MotionData','SensorPower'}, ... {'in','physical'}); sensorPorts(2).setInterface(physicalInterface) componentPlanning = addComponent(arch,"Planning"); planningPorts = addPort(componentPlanning.Architecture, ... {'Command','SensorPower1','MotionCommand'}, ... {'in','physical','out'}); planningPorts(2).setInterface(physicalInterface) componentMotion = addComponent(arch,"Motion"); motionPorts = addPort(componentMotion.Architecture,{'MotionCommand','MotionData'}, ... {'in','out'});
Create an owned interface on the MotionData
port. Add an owned data element under the owned data interface. Assign the data element Rotation
to a value type with units set to degrees
.
ownedInterface = motionPorts(2).createInterface("DataInterface"); ownedElement = ownedInterface.addElement("Rotation"); subInterface = ownedElement.createOwnedType(Units="degrees");
View the interfaces in the Interface Editor. Select the MotionData
port on the Motion
component. In the Interface Editor, switch from Dictionary View to Port Interface View.
Connect components with an interface rule and the default name rule. The interface rule connects ports on components that share the same interface. By default, the name rule connects ports on components that share the same name.
c_sensorData = connect(arch,componentSensor,componentPlanning,Rule="interface");
c_motionData = connect(arch,componentMotion,componentSensor);
c_motionCommand = connect(arch,componentPlanning,componentMotion);
Add and Connect Architecture Port
Add an architecture port on the architecture.
archPort = addPort(arch,"Command","in");
The connect
command requires a component port as an argument. Obtain the component port, then connect.
compPort = getPort(componentPlanning,"Command");
c_Command = connect(archPort,compPort);
Save the model.
model.save
Arrange the layout by pressıng Ctrl+Shift+A or using this command.
Simulink.BlockDiagram.arrangeSystem("mobileRobotAPI");
Create and Apply Profile with Stereotypes
Profiles are XML files that you can apply to any model. You can add stereotypes with properties to profiles and then populate the properties with specific values in the Profile Editor. Along with the built-in analysis capabilities of System Composer, stereotypes help you optimize your system for performance, cost, and reliability.
Create Profile and Add Stereotypes
Create a profile.
profile = systemcomposer.createProfile("GeneralProfile");
Create a stereotype that applies to all element types.
elemSType = addStereotype(profile,"projectElement");
Create stereotypes for different types of components. You select these types according to your design needs.
pCompSType = addStereotype(profile,"physicalComponent",AppliesTo="Component"); sCompSType = addStereotype(profile,"softwareComponent",AppliesTo="Component");
Create a stereotype for connections.
sConnSType = addStereotype(profile,"standardConn",AppliesTo="Connector");
Add Properties
Add properties to the stereotypes. You can use properties to capture metadata for model elements and analyze nonfunctional requirements. These properties are added to all elements to which the stereotype is applied, in any model that imports the profile.
addProperty(elemSType,'ID',Type="uint8"); addProperty(elemSType,'Description',Type="string"); addProperty(pCompSType,'Cost',Type="double",Units="USD"); addProperty(pCompSType,'Weight',Type="double",Units="g"); addProperty(sCompSType,'develCost',Type="double",Units="USD"); addProperty(sCompSType,'develTime',Type="double",Units="hour"); addProperty(sConnSType,'unitCost',Type="double"',Units="USD"); addProperty(sConnSType,'unitWeight',Type="double",Units="g"); addProperty(sConnSType,'length',Type="double",Units="m");
Save Profile
profile.save;
Apply Profile to Model
Apply the profile to the model.
applyProfile(model,"GeneralProfile");
Apply stereotypes to components. Some components are physical components, while others are software components.
applyStereotype(componentPlanning,"GeneralProfile.softwareComponent") applyStereotype(componentSensor,"GeneralProfile.physicalComponent") applyStereotype(componentMotion,"GeneralProfile.physicalComponent")
Apply the connector stereotype to all connections.
batchApplyStereotype(arch,'Connector',"GeneralProfile.standardConn");
Apply the general element stereotype to all connectors and ports.
batchApplyStereotype(arch,'Component',"GeneralProfile.projectElement"); batchApplyStereotype(arch,'Connector',"GeneralProfile.projectElement");
Set properties for each component.
setProperty(componentSensor,'GeneralProfile.projectElement.ID','001'); setProperty(componentSensor,'GeneralProfile.projectElement.Description', ... 'Central unit for all sensors'); setProperty(componentSensor,'GeneralProfile.physicalComponent.Cost','200'); setProperty(componentSensor,'GeneralProfile.physicalComponent.Weight','450'); setProperty(componentPlanning,'GeneralProfile.projectElement.ID','002'); setProperty(componentPlanning,'GeneralProfile.projectElement.Description', ... 'Planning computer'); setProperty(componentPlanning,'GeneralProfile.softwareComponent.develCost','20000'); setProperty(componentPlanning,'GeneralProfile.softwareComponent.develTime','300'); setProperty(componentMotion,'GeneralProfile.projectElement.ID','003'); setProperty(componentMotion,'GeneralProfile.projectElement.Description', ... 'Motor and motor controller'); setProperty(componentMotion,'GeneralProfile.physicalComponent.Cost','4500'); setProperty(componentMotion,'GeneralProfile.physicalComponent.Weight','2500');
Set the properties of connections to be identical.
connections = [c_sensorData c_motionData c_motionCommand c_Command]; for k = 1:length(connections) setProperty(connections(k),'GeneralProfile.standardConn.unitCost','0.2'); setProperty(connections(k),'GeneralProfile.standardConn.unitWeight','100'); setProperty(connections(k),'GeneralProfile.standardConn.length','0.3'); end
Add Hierarchy
Add two components named Controller
and Scope
inside the Motion
component. Define the ports. Connect the components to the architecture and to each other, applying a connector stereotype. Hierarchy in an architecture diagram creates an additional level of detail that specifies how components behave internally.
motionArch = componentMotion.Architecture; motionController = motionArch.addComponent('Controller'); controllerPorts = addPort(motionController.Architecture,{'controlIn','controlOut'}, ... {'in','out'}); controllerCompPortIn = motionController.getPort('controlIn'); controllerCompPortOut = motionController.getPort('controlOut'); motionScope = motionArch.addComponent('Scope'); scopePorts = addPort(motionScope.Architecture,{'scopeIn','scopeOut'},{'in','out'}); scopeCompPortIn = motionScope.getPort('scopeIn'); scopeCompPortOut = motionScope.getPort('scopeOut'); c_planningController = connect(motionPorts(1),controllerCompPortIn);
For output port connections, you can specify the destination data element.
c_planningScope = connect(scopeCompPortOut,motionPorts(2),DestinationElement="Rotation"); c_planningConnect = connect(controllerCompPortOut,scopeCompPortIn, ... "GeneralProfile.standardConn");
Save the model.
model.save
Arrange the layout by pressıng Ctrl+Shift+A or using this command.
Simulink.BlockDiagram.arrangeSystem("mobileRobotAPI/Motion");
Create Model Reference
Model references can help you organize large models hierarchically and define architectures or behaviors once that you can then reuse. When a component references another model, any existing ports on the component are removed, and ports that exist on the referenced model will appear on the component.
Create a new System Composer model. Convert the Controller
component into a reference component to reference the new model. To add ports on the Controller
component, you must update the referenced model mobileMotion
.
referenceModel = systemcomposer.createModel("mobileMotion"); referenceArch = referenceModel.Architecture; newComponents = addComponent(referenceArch,"Gyroscope"); referenceModel.save linkToModel(motionController,"mobileMotion");
Save the models.
referenceModel.save model.save
Make Variant Component
You can convert the Planning
component to a variant component using the makeVariant
function. The original component is embedded within a variant component as one of the available variant choices. You can design other variant choices within the variant component and toggle the active choice. Variant components allow you to choose behavioral designs programmatically in an architecture model to perform trade studies and analysis.
[variantComp,choice1] = makeVariant(componentMotion);
Add a variant choice named MotionAlt
. The second argument defines the name, and the third argument defines the label. The label identifies the choice. The active choice is controlled by the label.
choice2 = addChoice(variantComp,{'MotionAlt'},{'MotionAlt'});
Create the necessary ports on MotionAlt
.
motionAltPorts = addPort(choice2.Architecture,{'MotionCommand','MotionData'},{'in','out'});
Make MotionAlt
the active variant.
setActiveChoice(variantComp,"MotionAlt")
Arrange the layout by pressıng Ctrl+Shift+A or using this command.
Simulink.BlockDiagram.arrangeSystem("mobileRobotAPI/Planning");
Save the model.
model.save
Clean Up
Run this script to remove generated artifacts before you run this example again.
cleanUpArtifacts
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. Stereotypes allow you to style different elements. Stereotypes provide elements with a common set of properties, such as mass, cost, and power. | |
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. For more information, see Use Property Inspector in System Composer. | |
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. |
Version History
Introduced in R2019a
See Also
Tools
Blocks
Objects
Functions
systemcomposer.profile.Profile.createProfile
|systemcomposer.loadProfile
|applyProfile
|removeProfile
|renameProfile
|systemcomposer.profile.editor
|systemcomposer.profile.Profile.find
|systemcomposer.profile.Profile.load
|save
|open
|close
|systemcomposer.profile.Profile.closeAll
|systemcomposer.profile.Stereotype.find
|getDefaultStereotype
|setDefaultStereotype
|getDefaultElementStereotype
|setDefaultElementStereotype
|addStereotype
|removeStereotype
|getStereotype
|applyStereotype
|batchApplyStereotype
|getStereotypes
|changeStereotype
|removeStereotype
|hasStereotype
|addProperty
|removeProperty
|hasProperty
|setProperty
|getProperty
|getPropertyValue
|getEvaluatedPropertyValue
|getStereotypeProperties
|applyStereotypeOrder
|getStereotypeNamesByOrder
|increaseStereotypeOrder
|decreaseStereotypeOrder
MATLAB 명령
다음 MATLAB 명령에 해당하는 링크를 클릭했습니다.
명령을 실행하려면 MATLAB 명령 창에 입력하십시오. 웹 브라우저는 MATLAB 명령을 지원하지 않습니다.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)