removeControlVariable

R2026b

Remove variant control variable from variant configuration

Syntax

removeControlVariable(varConfigs,ConfigurationName=configName,ControlVariableName=ctrlVarName)

removeControlVariable(___,ControlVariableSource=ctrlVarSource)

Description

removeControlVariable(varConfigs,ConfigurationName=configName,ControlVariableName=ctrlVarName) removes the variant control variable named ctrlVarName from the configuration configName present in the Simulink.VariantConfigurations object varConfigs.

removeControlVariable(___,ControlVariableSource=ctrlVarSource) allows you to specify the name of the data source where the control variable is defined in addition to the input arguments in the previous syntax. Use this syntax if multiple control variables with the same name exist in different sources.

Examples

Remove Control Variable

Open the slexVariantReducer model.

modelName="slexVariantReducer";
open_system(modelName);

Remove the control variable W from the variant configuration config1.

varConfigs = Simulink.VariantManager.getVariantConfigurations(modelName);
removeControlVariable(varConfigs,ConfigurationName="config1",ControlVariableName="W");

Input Arguments

varConfigs — Variant configurations object

Simulink.VariantConfigurations object

Variant configurations object that contains the configuration from which you want to remove the control variable, specified as a Simulink.VariantConfigurations object.

configName — Name of variant configuration

character vector | string scalar

Name of the variant configuration from which the control variable is removed, specified as a character vector or string scalar. The configuration must be defined in varConfigs.

Example: "LinInterExpNoNoise"

Data Types: char | string

ctrlVarName — Name of control variable

character vector | string scalar

Name of the control variable to be removed from the variant configuration, specified as a character vector or string scalar.

Example: "PlantLoc"

Data Types: char | string

ctrlVarSource — Data source of control variable

character vector | string scalar

Data source of the control variable, specified as a character vector or string scalar.

Example: "topData.sldd"

Example: "base workspace"

Version History

Introduced in R2013b

R2026b: Moved to Simulink Variant Manager

Starting in R2026b, removeControlVariable is available in the Simulink^® Variant Manager™ product. In releases R2022b through R2026a, the function is available in the Variant Manager for Simulink support package. In earlier releases, the function is available in Simulink.

R2026a: Specify function arguments using Name=Value syntax

Specify input arguments for the removeControlVariable function using the Name=Value syntax. The function continues to support positional arguments, but it is recommended to use the Name=Value syntax instead.