setCondition

Set condition on variant choice

Syntax

setCondition(variantComponent,choice,expression)

Description

setCondition(variantComponent,choice,expression) sets the variant control condition for a choice on the variant component to choose the active variant choice. If the condition is met on a variant choice, that variant choice becomes the active choice on the variant component.

Examples

Set Variant Control Condition

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

model = systemcomposer.createModel("archModel",true);
arch = get(model,"Architecture");
mode = 1;
variant = addVariantComponent(arch,"Component1");
compList = addChoice(variant,["Choice1","Choice2"]);
setCondition(variant,compList(2),"mode == 2");

Input Arguments

variantComponent — Variant component

variant component object

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

choice — Choice in variant component

component object

Choice in variant component, specified by a systemcomposer.arch.Component object.

expression — Control string

character vector | string

Control string that controls the selection of choice, specified as a character vector or string.

Data Types: char | string

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

Version History

Introduced in R2019a