addControlVariables

R2026b

Add variant control variables to named variant configuration in variant configuration object

Syntax

addControlVariables(varConfigs,ConfigurationName=nameOfConfig,ControlVariables=variantCtrlVars)

Description

addControlVariables(varConfigs,ConfigurationName=nameOfConfig,ControlVariables=variantCtrlVars) adds variant control variables specified by variantCtrlVars to the variant configuration named nameOfConfig in a Simulink.VariantConfigurations object varConfigs.

Examples

Add Control Variables

1. Create an empty Simulink.VariantConfigurations object.

varConfigs = Simulink.VariantConfigurations

varConfigs = 
  VariantConfigurations with properties:

            Configurations: [1×0 struct]
               Constraints: [1×0 struct]
    PreferredConfiguration: ''

2. Create a variant configuration and add it to the variant configurations object.

Define a variant control variable.

PlantLoc = Simulink.VariantControl(Value=1,ActivationTime="code compile");

Create a variant control variable structure.

ctrlVarStruct = struct(Name="PlantLocation",Value=PlantLoc,Source="topdata.sldd")

ctrlVarStruct = struct with fields:
      Name: "PlantLocation"
     Value: [1×1 Simulink.VariantControl]
    Source: "topdata.sldd"

Add the new configuration to varConfigs.

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

3. Create a new variant control variable of type Simulink.VariantControl.

SmartSensorMod = Simulink.VariantControl(Value=2,ActivationTime="code compile");
newControlVarStruct = struct(Name="SmartSensorMod",Value=SmartSensorMod,Source="topdata.sldd")

newControlVarStruct = struct with fields:
      Name: "SmartSensorMod"
     Value: [1×1 Simulink.VariantControl]
    Source: "topdata.sldd"

4. Add the control variable to the existing variant configuration, InternalPlantConfig.

addControlVariables(varConfigs,ConfigurationName="InternalPlantConfig",ControlVariables=newControlVarStruct);

Input Arguments

varConfigs — Variant configurations object

Simulink.VariantConfigurations object

Variant configurations object in which nameOfConfig is defined, specified as a Simulink.VariantConfigurations object.

nameOfConfig — Name of variant configuration

character vector | string scalar

Name of the variant configuration to which the variant control variables must be added, specified as a character vector or string scalar. This configuration must be present in the variant configurations object, varConfigs.

Example: "LinInterExpNoNoise"

Data Types: char | string

variantCtrlVars — Variant control variable names and values

structure | array of structures

Control variables in variant configuration, specified as a structure or structure array with these fields:

• Name — Name of the control variable, specified as a character vector or string scalar.

• Value — Value of the control variable, specified as one of these data types:

  • MATLAB^® variable

  • Simulink.Parameter object

  • AUTOSAR.Parameter object

  • Simulink.VariantControl object

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

Example: ctrlVarStruct = struct(Name="Noise",Value="NoiseType.NoNoise",Source="plant.sldd");

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

Version History

Introduced in R2013b

R2026b: Moved to Simulink Variant Manager

Starting in R2026b, addControlVariables 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 addControlVariables function using the Name=Value syntax. The function continues to support positional arguments, but it is recommended to use the Name=Value syntax instead.