Main Content

getCondition

Return variant control on choice within variant component

collapse all in page

Syntax

expression = getCondition(variantComponent,choice)

Description

expression = getCondition(variantComponent,choice) gets the variant control condition for the choice choice on the variant component variantComponent 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.

example

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 a condition on one variant choice to choose the active variant choice, and get the condition.

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

Input Arguments

collapse all

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

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

Output Arguments

collapse all

Control string that controls the selection of the particular choice, returned as a character vector.

Data Types: char

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

Set Variant Control Condition

Version History

Introduced in R2019a

See Also

Blocks

Objects

Functions

Topics