makeVariant

Convert component to variant choice

Since R2019a

Syntax

[variantComp,choices] = makeVariant(component)

[variantComp,choices] = makeVariant(component,Name,Value)

Description

[variantComp,choices] = makeVariant(component) converts the component component to a variant choice component and returns the parent Variant Component block object variantComp and available variant choice components choices.

[variantComp,choices] = makeVariant(component,Name,Value) converts the component 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,true);
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: 61.0004
    SimulinkModelHandle: 4.8828e-04
                   UUID: 'b03dc99c-a11f-45b4-ac58-e458d6ab5bf6'
            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: 2.0028
    SimulinkModelHandle: 4.8828e-04
                   UUID: 'de400bb2-bd40-4914-941a-1614558b7fc2'
            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

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.	Compose Architectures Visually Author Parameters in System Composer Using Parameter Editor
model	A System Composer model is the file that contains architectural information, including components, ports, connectors, interfaces, and behaviors.	Perform operations on a model: Extract the root-level architecture contained in the model. Apply profiles. Link interface data dictionaries. Generate instances from model architecture. A System Composer model is stored as an SLX file.	Create Architecture Model with Interfaces and Requirement Links
component	A component is a nontrivial, nearly independent, and 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, a 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 interfaces using the Interface Editor Parameters using the Parameter Editor	Components
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.	There are different types of ports: Component ports are interaction points on the component to other components. Architecture ports are ports on the boundary of the system, whether the boundary is within a component or the overall architecture model.	Ports
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.	Connections

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 to programmatically control which variant is active.	Set Variant Control Condition

Version History

Introduced in R2019a