Simulink.VariantConfigurations

R2026b

Create and store variant configurations and constraints

Renamed from Simulink.VariantConfigurationData in R2026b

Description

Use a Simulink.VariantConfigurations object to store a collection of variant configurations, constraints that must be satisfied by the configurations, and the name of a preferred variant configuration for a model. You can define the variant configurations object in the base workspace or in the Design Data section of a Simulink^® data dictionary.

A variant configuration represents a specific set of variation points across the model hierarchy. It contains a group of variant control variables and their values, which you can use to activate a specific variant in the model hierarchy. A Simulink.VariantConfigurations object enables you to:

Define new variant configurations.
Add variant control variables to a variant configuration.
Define constraints to check for invalid variant configurations.
Add or remove association between variant configurations of top-level model and referenced model.
Delete existing variant configurations, constraints, and control variables.
Set a specific configuration as the preferred variant configuration.

Creation

Syntax

varconfigdata = Simulink.VariantConfigurations

varconfigdata = Simulink.VariantConfigurations(PropertyName=Value)

Description

varconfigdata = Simulink.VariantConfigurations creates an empty VariantConfigurations object.

varconfigdata = Simulink.VariantConfigurations(PropertyName=Value) creates a VariantConfigurations object and sets its properties using one or more property name-value arguments.

example

Properties

expand all

`Configurations` — Set of variant configurations
structure | structure array

This property is read-only after object creation.

Set of variant configurations in the variant configurations object, specified as a structure or structure array with these fields:

Field Type Description

Field	Type	Description
`Name`	character vector or string scalar	Name of the configuration. The value must be a unique and valid MATLAB^® variable name.
`Description`	character vector or string scalar	Description of the configuration.
`ControlVariables`	structure or structure array	Variant control variable names and their values, specified as a structure or structure array with the fields: `Name` — Name of the control variable, specified as a character vector or string scalar. `Value` — Value of the control variable, specified as any of these data types: MATLAB variable `Simulink.Parameter` `AUTOSAR.Parameter` `Simulink.VariantControl` `Source` — Data source of the control variable, specified as a character vector or string scalar. Example: `ctrlVarStruct=struct(Name="Ctrl",Value="ControllerType.Linear",Source="plant.sldd");` Example:`ctrlVarStruct=struct(Name="Vctrl",Value="1",Source="base workspace");` For an example that shows the use of different types of variant control variables, see Use Variant Control Variables in Variant Blocks.

Name

character vector or string scalar

Name of the configuration. The value must be a unique and valid MATLAB^® variable name.

Description

character vector or string scalar

Description of the configuration.

ControlVariables

structure or structure array

Variant control variable names and their values, specified as a structure or structure array with the fields:

Name — Name of the control variable, specified as a character vector or string scalar.
Value — Value of the control variable, specified as any of these data types:
- MATLAB variable
- Simulink.Parameter
- AUTOSAR.Parameter
- Simulink.VariantControl
Source — Data source of the control variable, specified as a character vector or string scalar.

Example: ctrlVarStruct=struct(Name="Ctrl",Value="ControllerType.Linear",Source="plant.sldd");

Example:ctrlVarStruct=struct(Name="Vctrl",Value="1",Source="base workspace");

For an example that shows the use of different types of variant control variables, see Use Variant Control Variables in Variant Blocks.

Data Types: struct

`Constraints` — Constraints for variant configurations
structure | structure array

This property is read-only after object creation.

Constraints that must be met by all variant configurations in the variant configuration object, specified as a structure or structure array with these fields:

Name — Name of the constraint, specified as a character vector or string scalar. The value must be a unique and valid MATLAB variable name.
Condition — Boolean expression defined using variant control variables, specified as a character vector or string scalar. The expression must evaluate to true to satisfy the constraint.
Description — Description of the constraint, specified as a character vector or string scalar.

Data Types: struct

`PreferredConfiguration` — Name of preferred variant configuration
character vector | string scalar

Name of the preferred variant configuration, specified as a character vector or string scalar. Use this property to indicate the configuration that is suited for the model for common workflows. The value must be the name of a variant configuration present in the variant configurations object.

Data Types: char | string

Object Functions

`addConfiguration`	Add new variant configuration to variant configurations object
`addReferencedConfiguration`	Associate top-model variant configuration with variant configuration of referenced model
`addConstraint`	Add constraint to variant configurations object
`addControlVariables`	Add variant control variables to named variant configuration in variant configuration object
`addCopyOfConfiguration`	Add copy of existing variant configuration to variant configurations object
`convertDefaultToPreferred`	Convert default variant configuration to preferred variant configuration
`getVariantConfiguration`	Get specific variant configuration from variant configurations object
`getConstraint`	Get constraint from variant configurations object
`getControlVariable`	Get variant control variable from variant configuration
`getReferencedConfigurationName`	Get name of variant configuration used by referenced component in model hierarchy
`getPreferredConfiguration`	Get name of preferred variant configuration for variant configurations object
`isConfigActive`	Check if variant configuration is active
`setPreferredConfiguration`	Set name of preferred variant configuration for variant configurations object
`removeConfiguration`	Remove variant configuration from variant configurations object
`removeReferencedConfiguration`	Remove association between variant configurations of top-level model and referenced model
`removeConstraint`	Remove constraint from variant configurations object
`setConstraint`	Modify condition and description of existing variant constraint
`removeControlVariable`	Remove variant control variable from variant configuration

These functions specialize standard MATLAB set operations for Simulink.VariantConfigurations objects.

`intersect`	`vcoC = intersect(vcoA,vcoB)` Find the intersection of variant configuration objects `vcoA` and `vcoB`. This function returns a variant configurations object, `vcoC`, with the common variant configurations present in `vcoA` and `vcoB`. The function finds the intersection by matching the variant control variables and their values. Constraints in `vcoC` are formed as follows. Consider the case where `vcoA` and `vcoB` have two constraints each. `vcoA` has constraints `constraintA1` and `constraintA2`. `vcoB` has constraints `constraintB1` and `constraintB2`. Then, `vcoC` has these constraints: `constraintA1 && (constraintB1 && constraintB2)` `constraintA2 && (constraintB1 && constraintB2)` The constraint conditions formed by logical `AND`, `OR`, and `NOT` operations are simplified by default and symbols can be reordered. `vcoC = intersect(vcoA,vcoB,SimplifyConditions=false)` returns a variant configurations object `vcoC` in which constraint conditions are not simplified. The remaining properties of `vcoC` are the same as `vcoA`, and the data in `vcoC` appears in the same order as in `vcoA`.
`setdiff`	`vcoC = setdiff(vcoA,vcoB)` Find the difference between variant configuration objects `vcoA` and `vcoB`. This function returns a variant configurations object `vcoC` that contains configurations that are in `vcoA` but not in `vcoB`. The function finds the difference by identifying changes in the values of variant control variables. Constraints in `vcoC` are formed as follows. Consider the case where `vcoA` and `vcoB` have two constraints each. `vcoA` has constraints `constraintA1` and `constraintA2` `vcoB` has constraints `constraintB1` and `constraintB2` Then, `vcoC` has these constraints: `constraintA1 && ~(constraintB1 && constraintB2)` `constraintA2 && ~(constraintB1 && constraintB2)` The constraint conditions formed by logical `AND`, `OR`, and `NOT` operations are simplified by default and symbols can be reordered. `vcoC = setdiff(vcoA,vcoB,SimplifyConditions=false)` returns a variant configurations object `vcoC` in which constraint conditions are not simplified. The remaining properties of `vcoC` are the same as `vcoA`, and the data in `vcoC` appears in the same order as in `vcoA`.
`union`	`vcoC = union(vcoA,vcoB)` Find the union of variant configuration objects `vcoA` and `vcoB`. This function returns a variant configurations object `vcoC` that contains configurations from both `vcoA` and `vcoB`, with no duplicates. The function finds the union by matching the variant control variables and their values. Constraints in `vcoC` are formed as follows. Consider the case where `vcoA` and `vcoB` have two constraints each. `vcoA` : `constraintA1`, `constraintA2` `vcoB` : `constraintB1`, `constraintB2` Then, `vcoC` has these constraints: `constraintA1 \|\| (constraintB1 && constraintB2)` `constraintA2 \|\| (constraintB1 && constraintB2)` The constraint conditions formed by logical `AND`, `OR`, and `NOT` operations are simplified by default and symbols can be reordered. `vcoC = union(vcoA,vcoB,SimplifyConditions=false)` returns a variant configurations object `vcoC` in which constraint conditions are not simplified. The remaining properties of `vcoC` are the same as `vcoA`, and the data in `vcoC` appears in the same order as in `vcoA`, then `vcoB`.
`unique`	`uniquedVCO = unique(vco)` Find unique configurations in the variant configurations object `vco`. Duplicate configurations in `vco` are removed by comparing the values of variant control variables. Duplicate constraints in `vco` are removed by comparing the constraint conditions.

Examples

collapse all

Create Variant Configurations Object

Open Live Script

This example shows how to create a Simulink.VariantConfigurations object and set these object properties:

Configurations
Constraints
PreferredConfiguration

Define New Variant Configuration

Define a new variant configuration to add to the variant configurations object.

The Configurations property of a Simulink.VariantConfigurations object is a structure with these fields:

Name
ControlVariables
Description

Create a structure for the ControlVariables field that contains the variant control variables and values for the new configuration.

ctrlVarStructA(1).Name = "Ctrl";
ctrlVarStructA(1).Value = "ControllerType.Linear";
ctrlVarStructA(1).Source = "topData.sldd";
ctrlVarStructA(2).Name = "Noise";
ctrlVarStructA(2).Value = "NoiseType.NoNoise";
ctrlVarStructA(2).Source = "topData.sldd";
ctrlVarStructA(3).Name = "PlantLoc";
ctrlVarStructA(3).Value = "PlantLocation.Internal";
ctrlVarStructA(3).Source = "topData.sldd";
ctrlVarStructA(4).Name = "FidType";
ctrlVarStructA(4).Value = "Fidelity.High";
ctrlVarStructA(4).Source = "plantData.sldd";

Create a structure for the new variant configuration.

configStruct(1).Name = "LinInterExpNoNoise";
configStruct(1).ControlVariables = ctrlVarStructA;
configStruct(1).Description = "Linear Internal Plant Controller";

Define a second variant configuration.

ctrlVarStructB(1).Name = "Ctrl";
ctrlVarStructB(1).Value = "ControllerType.Nonlinear";
ctrlVarStructB(1).Source = "topData.sldd";
ctrlVarStructB(2).Name = "Noise";
ctrlVarStructB(2).Value = "NoiseType.NoNoise";
ctrlVarStructB(2).Source = "topData.sldd";
ctrlVarStructB(3).Name = "PlantLoc";
ctrlVarStructB(3).Value = "PlantLocation.External";
ctrlVarStructB(3).Source = "topData.sldd";
ctrlVarStructB(4).Name = "FidType";
ctrlVarStructB(4).Value = "Fidelity.Low";
ctrlVarStructB(4).Source = "plantData.sldd";

configStruct(2).Name = "NonLinExterLowFid";
configStruct(2).ControlVariables = ctrlVarStructB;
configStruct(2).Description = "Nonlinear External Plant Controller";

Define Constraints

Define any constraints applicable for all the variant configurations in the variant configurations object.

constrStruct = struct(Name="PlantLocation", ...
  Condition="(PlantLoc==PlantLocation.Internal) || (PlantLoc==PlantLocation.External)", ...
 Description="Plant location constraint");

Create Variant Configurations Object

Create the object by adding variant configurations, constraints, and the name of the preferred configuration.

 varConfigs = Simulink.VariantConfigurations(Configurations=configStruct,Constraints=constrStruct, ...
  PreferredConfiguration="LinInterExpNoNoise")

varConfigs = 
  VariantConfigurations with properties:

            Configurations: [1×2 struct]
               Constraints: [1×1 struct]
    PreferredConfiguration: 'LinInterExpNoNoise'

Associate or Disassociate Variant Configurations Object from Model

You can associate varConfigs with a Simulink® model using the VariantConfigurations model parameter.

set_param("model",VariantConfigurations="varConfigs");

To disassociate varConfigs from the model, set the VariantConfigurations model parameter to an empty character vector or string.

set_param("model",VariantConfigurations="");

Save the model to save your changes.

 save_system("model");

Tips

You can edit a variant configurations object from the base workspace or data dictionary without launching Variant Manager. Double-click the object in the base workspace or in the Design Data section of the data dictionary in the Model Explorer. This action launches the Simulink.VariantConfigurations property dialog box. This dialog box functions as a standalone variant manager and allows you to modify variant configurations, control variables, and constraints in the variant configurations object.

Version History

Introduced in R2013b

expand all

R2026b: Moved to Simulink Variant Manager

Starting in R2026b, Simulink.VariantConfigurations is available in the Simulink Variant Manager™ product. In releases R2022b through R2026a, the object is available in the Variant Manager for Simulink support package. In earlier releases, the object is available in Simulink.

R2026b: Renamed from `Simulink.VariantConfigurationData`

The Simulink.VariantConfigurationData object has been renamed to Simulink.VariantConfigurations. The behavior remains the same.

The new name better describes the purpose of the object and is consistent with other Variant Manager terminology. The old object name continues to work as an alias, but it will be removed in a future release. If you have scripts that create or reference Simulink.VariantConfigurationData objects, update them to use Simulink.VariantConfigurations.

Before R2026b	R2026b
vcs = Simulink.VariantConfigurationData;	vcs = Simulink.VariantConfigurations;

R2026b: Variant configuration objects stored in Design Data section of data dictionaries

Starting in R2026b, variant configuration objects are stored in the Design Data section of Simulink data dictionaries, alongside the variant control variables they reference. This change enables you to use the same data dictionary command line functions and workflows to access both variant configuration objects and variant control variables. Previously, variant configuration objects were stored in the Configurations section, separate from the variant control variables defined in Design Data.

When you add, import, or move variant configuration objects into a data dictionary, they are now placed in the Design Data section.

If you have scripts that use data dictionary functions to access variant configuration objects from the Configurations section, update them to access the Design Data section instead.

Before R2026b	R2026b
dictObj = Simulink.data.dictionary.open('dModel.sldd'); configurationsSection = dictObj.getSection('Configurations'); vco = evalin(configurationsSection, 'vco');	dictObj = Simulink.data.dictionary.open('dModel.sldd'); designDataSection = dictObj.getSection('Design Data'); vco = evalin(designDataSection, 'vco');

Before R2026b

R2026b

dictObj = Simulink.data.dictionary.open('dModel.sldd');
configurationsSection = dictObj.getSection('Configurations');
vco = evalin(configurationsSection, 'vco');

dictObj = Simulink.data.dictionary.open('dModel.sldd');
designDataSection = dictObj.getSection('Design Data');
vco = evalin(designDataSection, 'vco');

R2026b: `VariantConfigurationObject` model parameter renamed to `VariantConfigurations`

The VariantConfigurationObject model parameter, which contains the name of the variant configuration data object associated with the model, has been renamed to VariantConfigurations. This change makes the parameter name consistent with the Simulink.VariantConfigurations object name. The old parameter name continues to work as an alias, but it will be removed in a future release. If you have scripts that use the VariantConfigurationObject parameter, update them to use VariantConfigurations.

Before R2026b	R2026b
get_param('myModel', 'VariantConfigurationObject');	get_param('myModel', 'VariantConfigurations');

R2026a: Specify arguments of `Simulink.VariantConfigurationData` object functions using `Name=Value` syntax

Specify input arguments for functions of the Simulink.VariantConfigurationData object using the Name=Value syntax. The functions continue to support positional arguments, but it is recommended to use the Name=Value syntax instead.

For example, the following table compares the positional argument syntax and the newly supported Name=Value syntax for the addConfiguration function. Here, varConfigData is a Simulink.VariantConfigurationData object.

Before R2026a	From R2026a
addConfiguration(varConfigData, ... "InternalPlantConfig", ... "Internal Plant Controller", ... ctrlVarStruct);	addConfiguration(varConfigData, ... ConfigurationName="InternalPlantConfig", ... Description="Internal Plant Controller", ... ControlVariables=ctrlVarStruct);

Before R2026a

From R2026a

addConfiguration(varConfigData, ...
 "InternalPlantConfig", ...
 "Internal Plant Controller", ...
 ctrlVarStruct);

addConfiguration(varConfigData, ...
 ConfigurationName="InternalPlantConfig", ...
 Description="Internal Plant Controller", ...
 ControlVariables=ctrlVarStruct);

R2025a: New `isConfigActive` function

The isConfigActive function checks whether the specified configuration is the active configuration for a model. Use the function to specify a component configuration name in the condition expression used to define a variant constraint.

R2022b: New add-on required

You must install the Variant Manager for Simulink software support package to use this object and its functions.

R2022b: New capabilities

Support for set operations:
You can use the intersect, setdiff, union, and unique functions with Simulink.VariantConfigurationData objects to perform set operations on the objects. See Object Functions.
New PreferredConfiguration property:
You can set any of the named configurations defined for a model as the PreferredConfiguration to indicate the configuration that is suited for the model for common workflows. This configuration is not applied automatically when compiling or simulating a model. You must apply the preferred configuration explicitly on the model, if required.
If the variant configuration data object (vcd) for your model has an existing DefaultConfiguration, you can convert it to PreferredConfiguration using this command:
```
convertDefaultToPreferred(vcd);
```
To apply the PreferredConfiguration on your model before compiling or simulating the model, use this command:
```
Simulink.VariantManager.applyConfiguration(model,...
getPreferredConfigurationName(vcd));
```

R2022b: `DefaultConfigurationName` and `SubModelConfiguration` properties will be removed

The DefaultConfigurationName property will be removed. Use the PreferredConfiguration property instead. Setting a default variant configuration for a variant configuration data object is not recommended. Previously, if you had set a default configuration, compiling or simulating the model automatically activated the default configuration irrespective of the variant control variable values in the base workspace or data dictionary used by the model. Now, this behavior is not applicable and setting the DefaultConfigurationName property has no effect.
If the variant configuration data object (vcd) for your model has an existing DefaultConfiguration, you can convert it to PreferredConfiguration using the convertDefaultToPreferred function.
The SubModelConfiguration property will be removed. The variant configurations for a top-level model must also define the variant control variables used by any referenced components in the model hierarchy, such as referenced models. This approach helps to maintain a single consistent definition for a variant control across the hierarchy.
If the referenced component has named variant configurations of its own, you can use them to set up the corresponding variant control variables in the top-level model configuration. For more information, see Compose Variant Configurations and Constraints for Top Model Using Referenced Configurations.
For existing models with an associated variant configuration object, variant control variables in the referenced model configuration will be automatically migrated to the configuration of the top-level model. You must save the variant configuration object using Variant Manager to fix related warnings.

Scripts that use these properties run with a warning.

R2022b: Functions to be removed

These functions will be removed in a future release. Scripts that use these functions run with a warning.

To be Removed	Recommended Replacement
`validateModel`	`Simulink.VariantManager.activateModel`
`getFor`	`Simulink.VariantManager.getVariantConfigurations`
`addSubModelConfigurations`	`Simulink.VariantConfigurationData.addComponentConfiguration`
`removeSubModelConfiguration`	`Simulink.VariantConfigurationData.removeComponentConfiguration`
`getDefaultConfiguration`	`Simulink.VariantConfigurationData.getPreferredConfiguration`
`setDefaultConfigurationName`	`Simulink.VariantConfigurationData.setPreferredConfiguration`

R2022b: Change in the format of errors output argument of `validateModel` function

The fields Type, Source, PathInModel, and PathInHierarchy have been removed from the structure named Errors within the second output argument, errors.

Simulink.VariantConfigurations

Description

Creation

Syntax

Description

Properties

`Configurations` — Set of variant configurations
structure | structure array

`Constraints` — Constraints for variant configurations
structure | structure array

`PreferredConfiguration` — Name of preferred variant configuration
character vector | string scalar

Object Functions

Examples

Create Variant Configurations Object

Tips

Version History

R2026b: Moved to Simulink Variant Manager

R2026b: Renamed from `Simulink.VariantConfigurationData`

R2026b: Variant configuration objects stored in Design Data section of data dictionaries

R2026b: `VariantConfigurationObject` model parameter renamed to `VariantConfigurations`

R2026a: Specify arguments of `Simulink.VariantConfigurationData` object functions using `Name=Value` syntax

R2025a: New `isConfigActive` function

R2022b: New add-on required

R2022b: New capabilities

R2022b: `DefaultConfigurationName` and `SubModelConfiguration` properties will be removed

R2022b: Functions to be removed

R2022b: Change in the format of errors output argument of `validateModel` function

See Also

Apps

Namespaces

Objects

Functions

Topics

Simulink.VariantConfigurations

Description

Creation

Syntax

Description

Properties

Configurations — Set of variant configurations structure | structure array

Constraints — Constraints for variant configurations structure | structure array

PreferredConfiguration — Name of preferred variant configuration character vector | string scalar

Object Functions

Examples

Create Variant Configurations Object

Tips

Version History

R2026b: Moved to Simulink Variant Manager

R2026b: Renamed from Simulink.VariantConfigurationData

R2026b: Variant configuration objects stored in Design Data section of data dictionaries

R2026b: VariantConfigurationObject model parameter renamed to VariantConfigurations

R2026a: Specify arguments of Simulink.VariantConfigurationData object functions using Name=Value syntax

R2025a: New isConfigActive function

R2022b: New add-on required

R2022b: New capabilities

R2022b: DefaultConfigurationName and SubModelConfiguration properties will be removed

R2022b: Functions to be removed

R2022b: Change in the format of errors output argument of validateModel function

See Also

Apps

Namespaces

Objects

Functions

Topics

`Configurations` — Set of variant configurations
structure | structure array

`Constraints` — Constraints for variant configurations
structure | structure array

`PreferredConfiguration` — Name of preferred variant configuration
character vector | string scalar

R2026b: Renamed from `Simulink.VariantConfigurationData`

R2026b: `VariantConfigurationObject` model parameter renamed to `VariantConfigurations`

R2026a: Specify arguments of `Simulink.VariantConfigurationData` object functions using `Name=Value` syntax

R2025a: New `isConfigActive` function

R2022b: `DefaultConfigurationName` and `SubModelConfiguration` properties will be removed

R2022b: Change in the format of errors output argument of `validateModel` function