getChoices

Get available choices in variant component

Syntax

compList = getChoices(variantComponent)

Description

compList = getChoices(variantComponent) returns the list of choices available for a variant component.

Examples

Get First Variant Choice

Create a model, get the root architecture, create a one variant component, add two choices for the variant component, and get the first choice.

model = systemcomposer.createModel("archModel");
systemcomposer.openModel("archModel");
arch = get(model,"Architecture");
variant = addVariantComponent(arch,"Component1");
compList = addChoice(variant,["Choice1","Choice2"]);
choices = getChoices(variant);
variantChoice = choices(1)

variantChoice = 
  Component with properties:

     IsAdapterComponent: 0
           Architecture: [1×1 systemcomposer.arch.Architecture]
                   Name: 'Choice1'
                 Parent: [1×1 systemcomposer.arch.Architecture]
                  Ports: [0×0 systemcomposer.arch.ComponentPort]
             OwnedPorts: [0×0 systemcomposer.arch.ComponentPort]
      OwnedArchitecture: [1×1 systemcomposer.arch.Architecture]
             Parameters: [0×0 systemcomposer.arch.Parameter]
               Position: [15 15 135 115]
                  Model: [1×1 systemcomposer.arch.Model]
         SimulinkHandle: 216.0255
    SimulinkModelHandle: 149.0524
                   UUID: 'eca3bc77-1558-44df-90b4-13a0f0bbbf16'
            ExternalUID: ''

Input Arguments

variantComponent — Variant component

variant component object

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

Output Arguments

compList — Choices available for variant component

array of component objects

Choices available for variant component, returned as an array of systemcomposer.arch.Component objects.

More About

Definitions

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