Simulink.VariantConfigurationData - Create and store variant configurations and constraints - MATLAB (original) (raw)

Create and store variant configurations and constraints

Description

Note

This object requires Variant Manager for Simulink®.

Use a Simulink.VariantConfigurationData 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 configuration data object in the base workspace or in theConfigurations 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. ASimulink.VariantConfigurationData 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

Description

`varconfigdata` = Simulink.VariantConfigurationData creates an empty VariantConfigurationData object.

`varconfigdata` = Simulink.VariantConfigurationData([PropertyName=Value](#mw%5F27c9d458-1ece-476d-a1f7-734013898d17)) creates a VariantConfigurationData object and sets its properties using one or more property name-value arguments.

example

Properties

expand all

This property is read-only after object creation.

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

Data Types: struct

This property is read-only after object creation.

Constraints that must be met by all variant configurations in the variant configuration data 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

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 configuration data object.

Data Types: char | string

Object Functions

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

Examples

collapse all

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

• Configurations
• Constraints
• PreferredConfiguration

Define New Variant Configuration

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

The Configurations property of a Simulink.VariantConfigurationData 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 configuration data object.

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

Create Variant Configuration Data Object

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

vcdo = Simulink.VariantConfigurationData(Configurations=configStruct,Constraints=constrStruct, ... PreferredConfiguration="LinInterExpNoNoise")

vcdo = VariantConfigurationData with properties:

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

Associate or Disassociate Variant Configuration Data Object from Model

You can associate vcdo with a Simulink® model using the VariantConfigurationObject model parameter.

set_param("model",VariantConfigurationObject="vcdo");

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

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

Save the model to save your changes.

Tips

You can edit a variant configuration object from the base workspace or data dictionary without launching Variant Manager. Double-click the object in the base workspace or in theConfigurations section of the data dictionary in the Model Explorer. This action launches the Simulink.VariantConfigurationData 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 configuration object.

Version History

Introduced in R2013b

expand all

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.

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

• Support for set operations:
  You can use the intersect, setdiff,union, and unique functions withSimulink.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 thePreferredConfiguration 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 toPreferredConfiguration 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));

• The DefaultConfigurationName property will be removed. Use thePreferredConfiguration 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 toPreferredConfiguration 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 Component 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.

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