makeVariant
Convert component to variant choice
Syntax
Description
[
converts the component variantComp
,choices
] = makeVariant(component
)component
to a variant choice component and
returns the parent Variant
Component block object variantComp
and available variant
choice components choices
.
[
converts the component variantComp
,choices
] = makeVariant(component
,Name=Value
)component
to a variant choice component with
additional options and returns the parent Variant
Component block object variantComp
and available variant
choice components choices
.
Examples
Make Variant Component
Create a top-level architecture model.
modelName = "archModel"; arch = systemcomposer.createModel(modelName); systemcomposer.openModel(modelName); rootArch = get(arch,"Architecture");
Create a new component.
newComponent = addComponent(rootArch,"Component");
Add ports to the component.
inPort = addPort(newComponent.Architecture,"testSig","in"); outPort = addPort(newComponent.Architecture,"testSig","out");
Make the component into a variant component.
[variantComp,choices] = makeVariant(newComponent)
variantComp = VariantComponent with properties: Architecture: [1x1 systemcomposer.arch.Architecture] Name: 'Component' Parent: [1x1 systemcomposer.arch.Architecture] Ports: [1x2 systemcomposer.arch.ComponentPort] OwnedPorts: [1x2 systemcomposer.arch.ComponentPort] OwnedArchitecture: [1x1 systemcomposer.arch.Architecture] Parameters: [0x0 systemcomposer.arch.Parameter] Position: [15 15 65 83] Model: [1x1 systemcomposer.arch.Model] SimulinkHandle: 212.0016 SimulinkModelHandle: 152.0013 UUID: 'fc5683f7-c11e-4e90-8502-d3e5e1d8461f' ExternalUID: ''
choices = Component with properties: IsAdapterComponent: 0 Architecture: [1x1 systemcomposer.arch.Architecture] Name: 'Component' Parent: [1x1 systemcomposer.arch.Architecture] Ports: [1x2 systemcomposer.arch.ComponentPort] OwnedPorts: [1x2 systemcomposer.arch.ComponentPort] OwnedArchitecture: [1x1 systemcomposer.arch.Architecture] Parameters: [0x0 systemcomposer.arch.Parameter] Position: [50 20 100 80] Model: [1x1 systemcomposer.arch.Model] SimulinkHandle: 154.0028 SimulinkModelHandle: 152.0013 UUID: '4687f2d4-324a-4bca-94cd-a0f602afab88' ExternalUID: ''
Make Variant Component in Expression Mode
Create a top-level architecture model.
modelName = "archModel"; arch = systemcomposer.createModel(modelName); systemcomposer.openModel(modelName); rootArch = get(arch,"Architecture");
Create a new component.
newComponent = addComponent(rootArch,"Component");
Add ports to the component.
inPort = addPort(newComponent.Architecture,"testSig","in"); outPort = addPort(newComponent.Architecture,"testSig","out");
Make the component into a variant component in expression
mode.
[variantComp,choices] = makeVariant(newComponent, VariantControl = "V==1", VariantActivationTime = "update diagram", AllowZeroVariantControls="on")
variantComp = VariantComponent with properties: Name: 'Component' Parent: [1x1 systemcomposer.arch.Architecture] Ports: [1x2 systemcomposer.arch.ComponentPort] OwnedPorts: [1x2 systemcomposer.arch.ComponentPort] OwnedArchitecture: [1x1 systemcomposer.arch.Architecture] Parameters: [0x0 systemcomposer.arch.Parameter] Position: [15 15 65 83] Model: [1x1 systemcomposer.arch.Model] SimulinkHandle: 212.0017 SimulinkModelHandle: 152.0015 UUID: '44187cde-7a44-49c1-aacb-c313b50b66e0' ExternalUID: ''
choices = Component with properties: IsAdapterComponent: 0 Architecture: [1x1 systemcomposer.arch.Architecture] Name: 'Component' Parent: [1x1 systemcomposer.arch.Architecture] Ports: [1x2 systemcomposer.arch.ComponentPort] OwnedPorts: [1x2 systemcomposer.arch.ComponentPort] OwnedArchitecture: [1x1 systemcomposer.arch.Architecture] Parameters: [0x0 systemcomposer.arch.Parameter] Position: [50 20 100 80] Model: [1x1 systemcomposer.arch.Model] SimulinkHandle: 154.0029 SimulinkModelHandle: 152.0015 UUID: '35a1ad78-367c-499f-91fc-dbf3a87e1bc1' ExternalUID: ''
Input Arguments
component
— Component
component object
Component to be converted to variant choice component, specified as a systemcomposer.arch.Component
object.
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: [variantComp,choices] =
makeVariant(newComponent,Name="NewVariantComponent",Label="NewVariantChoice",Choices=["NewVariantChoiceA","NewVariantChoiceB","NewVariantChoiceC"],ChoiceLabels=["Choice
A","Choice B","Choice C"])
Name
— Name of variant component
character vector | string
Name of variant component, specified as a character vector or string.
Example: [variantComp,choices] =
makeVariant(newComponent,Name="NewVariantComponent")
Data Types: char
| string
Label
— Label of variant choice
character vector | string
Label of variant choice from converted component, specified as a character vector or string.
Example: [variantComp,choices] =
makeVariant(newComponent,Name="NewVariantComponent",Label="NewVariantChoice")
Data Types: char
| string
Choices
— Variant choice names
cell array of character vectors | array of strings
Variant choice names, specified as a cell array of character vectors or an array of strings. Additional variant choices are also added to the new variant component, along with the active choice from the converted component.
Example: [variantComp,choices] =
makeVariant(newComponent,Choices=["NewVariantChoiceA","NewVariantChoiceB","NewVariantChoiceC"])
Data Types: char
| string
ChoiceLabels
— Variant choice labels
cell array of character vectors | array of strings
Variant choice labels, specified as a cell array of character vectors or an array of strings.
Example: [variantComp,choices] =
makeVariant(newComponent,Choices=["NewVariantChoiceA","NewVariantChoiceB","NewVariantChoiceC"],ChoiceLabels=["Choice
A","Choice B","Choice C"])
Data Types: char
| string
VariantControl
— Variant control expression
true
or false
(default) | boolean condition expression | a Simulink.VariantExpression
object representing a boolean
condition expression
Variant control expression, specified as boolean expression. The active variant
choice is determined based on the evaluation of the boolean expression. The variant
component created is in expression
mode.
Example: [variantComp,choices] = makeVariant(newComponent, VariantControl
= ‘V==1’)
Data Types: char
| string
VariantActivationTime
— Variant activation time
update diagram
| update diagram analyze all choices
Variant activation time, specified as a string or character vector. The active
variant choice is determined based on the evaluation of the boolean expression. For a
Reference Component with Simulink® behaviour, the variant activation times supported are : update
diagram
, update diagram analyze all choices
,
code compile
, startup
,
runtime
, and inherit from
Simulink.VariantControl
.
Example: [variantComp,choices] = makeVariant(newComponent, VariantControl
= ‘V==1’,VariantActivationTime = update diagram)
Dependencies
To enable this parameter, you must specify
VariantControl
.
Data Types: char
| string
AllowZeroVariantControl
— Allow zero active variant choice
off
(default) | on
Allow zero active variant choice option of the Variant Component, specified as
off
or on
.
Example: [variantComp,choices] = makeVariant(newComponent, VariantControl
= ‘V==1’, AllowZeroVariantControls=’on’)
Dependencies
To enable this parameter, you must specify
VariantControl
.
Output Arguments
variantComp
— Variant component
variant component object
Variant component, returned as a systemcomposer.arch.VariantComponent
object.
choices
— Variant choices
array of component objects
Variant choices, returned as an array of systemcomposer.arch.Component
objects.
Data Types: char
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. | |
root | A root is at the top of an architecture hierarchy. A root architecture has a boundary defined by its architecture ports that surround the system of interest. | The root architecture has a system boundary surrounding your architecture model. You can add architecture ports that define interfaces across the boundary. | |
model | A System Composer model is the file that contains architectural information, such as components, ports, connectors, interfaces, and behaviors. |
Perform operations on a model:
A System Composer model is stored as an SLX file. | Create Architecture Model with Interfaces and Requirement Links |
component | A component is a 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, another 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 | 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. |
| |
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. |
Term | Definition | Application | More Information |
---|---|---|---|
variant | A variant is one of many structural or behavioral choices in a variant component. | Use variants to quickly swap different architectural designs for a component while performing analysis. | Create Variants |
variant control | A variant control is a string that controls the active variant choice. | Set the variant control programmatically to control which variant is active. | Set Variant Control Condition |
Version History
Introduced in R2019a
See Also
Blocks
Objects
Functions
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
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)