Main Content

makeVariant

Convert component to variant choice

Description

example

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

[variantComp,choices] = makeVariant(component,Name,Value) converts the component component to a variant choice component with additional options and returns the parent variant component and available variant choice components.

Examples

collapse all

Create two components with two ports each.

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 components.

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: [1×1 systemcomposer.arch.Architecture]
                   Name: 'Component'
                 Parent: [1×1 systemcomposer.arch.Architecture]
                  Ports: [1×2 systemcomposer.arch.ComponentPort]
             OwnedPorts: [1×2 systemcomposer.arch.ComponentPort]
      OwnedArchitecture: [1×1 systemcomposer.arch.Architecture]
               Position: [15 13 65 81]
                  Model: [1×1 systemcomposer.arch.Model]
         SimulinkHandle: 69.0001
    SimulinkModelHandle: 1.2207e-04
                   UUID: 'ee705b8f-b383-4230-a1a2-3c69fb081cc5'
            ExternalUID: ''


choices = 

  Component with properties:

     IsAdapterComponent: 0
           Architecture: [1×1 systemcomposer.arch.Architecture]
                   Name: 'Component'
                 Parent: [1×1 systemcomposer.arch.Architecture]
                  Ports: [1×2 systemcomposer.arch.ComponentPort]
             OwnedPorts: [1×2 systemcomposer.arch.ComponentPort]
      OwnedArchitecture: [1×1 systemcomposer.arch.Architecture]
               Position: [50 20 100 76]
                  Model: [1×1 systemcomposer.arch.Model]
         SimulinkHandle: 62.0001
    SimulinkModelHandle: 1.2207e-04
                   UUID: '5ad838ca-f993-4349-aac9-2efca6d2066e'
            ExternalUID: ''

Open the system and arrange it. Save the model.

open(arch)
Simulink.BlockDiagram.arrangeSystem('archModel');
save(arch)

Input Arguments

collapse all

Architecture component to be converted to variant choice component, specified as a systemcomposer.arch.Component object.

Name-Value 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: [variantComp,choices] = makeVariant(newComponent,'Name','NewVariantComponent','Label','NewVariantChoice','Choices',{'NewVariantChoiceA','NewVariantChoiceB','NewVariantChoiceC'},'ChoiceLabels',{'Choice A','Choice B','Choice C'})

Name of variant component, specified as a character vector or string.

Example: [variantComp,choices] = makeVariant(newComponent,'Name','NewVariantComponent')

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

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

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

collapse all

Variant component, returned as a systemcomposer.arch.VariantComponent object.

Variant choices, returned as an array of systemcomposer.arch.Component objects.

Data Types: char

More About

collapse all

Definitions

TermDefinitionApplicationMore Information
architectureA System Composer™ architecture represents a system of components and how they interface with each other structurally and behaviorally. You can represent specific architectures using alternate views.

Different types of architectures describe different aspects of systems:

  • Functional architecture describes the flow of data in a system.

  • Logical architecture describes the intended operation of a system.

  • Physical architecture describes the platform or hardware in a system.

Compose Architecture Visually
modelA 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.

System Composer models are stored as SLX files.

Create an Architecture Model with Interfaces and Requirement Links
componentA 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 architecture 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.Components
portA 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
connectorConnectors 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

TermDefinitionApplicationMore Information
variantA 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 controlA variant control is a string that controls the active variant choice.Set the variant control to programmatically control which variant is active.Set Condition

Introduced in R2019a