Main Content

getActiveChoice

Get active choice on variant component

Since R2019a

collapse all in page

Syntax

choice = getActiveChoice(variantComponent)

Description

example

choice = getActiveChoice(variantComponent) finds which choice is active for the variant component.

Examples

collapse all

Open Live Script

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

model = systemcomposer.createModel("archModel");
systemcomposer.openModel("archModel");
arch = get(model,"Architecture");
variant = addVariantComponent(arch,"Component1");
compList = addChoice(variant,["Choice1","Choice2"]);
setActiveChoice(variant,compList(2));
comp = getActiveChoice(variant)
comp = 
  Component with properties:

     IsAdapterComponent: 0
           Architecture: [1x1 systemcomposer.arch.Architecture]
                   Name: 'Choice2'
                 Parent: [1x1 systemcomposer.arch.Architecture]
                  Ports: [0x0 systemcomposer.arch.ComponentPort]
             OwnedPorts: [0x0 systemcomposer.arch.ComponentPort]
      OwnedArchitecture: [1x1 systemcomposer.arch.Architecture]
             Parameters: [0x0 systemcomposer.arch.Parameter]
               Position: [15 15 65 76]
                  Model: [1x1 systemcomposer.arch.Model]
         SimulinkHandle: 72.0012
    SimulinkModelHandle: 0.0092
                   UUID: '1d0be7cb-cf53-4aad-9c7c-c3ce9dc489c2'
            ExternalUID: ''

Input Arguments

collapse all

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

Output Arguments

collapse all

Chosen variant, returned as a systemcomposer.arch.Component object.

More About

collapse all

Definitions

TermDefinitionApplicationMore 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

See Also

Blocks

Objects

Functions

Topics