getComponentConfigurationName

Get name of variant configuration used by referenced component in model hierarchy

Since R2023b

collapse all in page

    Syntax

    refConfigName = getComponentConfigurationName(varconfigdatatop,ConfigurationName=topmdlconfig,ComponentName=refmdlname)

    Description

    In a model that has predefined variant configurations and also has a referenced model in its model hierarchy, the referenced model can define its own variant configurations. While authoring the variant configurations for the top-level model, you can associate a referenced model configuration with a top-level variant configuration to populate the corresponding control variables in the top-level configuration. Use the getComponentConfigurationName function to get the name of the referenced model configuration used within a top-level variant configuration. For more information, see Compose Variant Configurations and Constraints for Top Model Using Referenced Component Configurations.

    Note

    This function requires Variant Manager for Simulink®.

    refConfigName = getComponentConfigurationName(varconfigdatatop,ConfigurationName=topmdlconfig,ComponentName=refmdlname) returns the name of the variant configuration used by the referenced component refmdlname in the top-level model variant configuration topmdlconfig. The variant configuration topmdlconfig must be defined in varconfigdatatop, the Simulink.VariantConfigurationData object associated with the top-level model.

    example

    Examples

    collapse all

    LinExterHighFid is a variant configuration defined for the top-level model slexVariantManagement and is present in the variant configuration data object vcd. Get the name of the variant configuration used by the referenced component slexVariantManagementExternalPlantMdlRef in the variant configuration LinExterHighFid:

    modelname = "slexVariantManagement";
openExample(modelname);
vcd = Simulink.VariantManager.getConfigurationData(modelname);
refSelectedConfig = getComponentConfigurationName...
(vcd,ConfigurationName="LinExterHighFid",...
ComponentName="slexVariantManagementExternalPlantMdlRef");

    Input Arguments

    collapse all

    Variant configuration data of the top-level model, specified as a Simulink.VariantConfigurationData object.

    Name of the variant configuration of top-level model from which the configuration used by the referenced component refmdlname is retrieved, specified as a character vector or string scalar. topmdlconfig must be defined in varconfigdatatop.

    Example: "LinExterHighFid"

    Data Types: char | string

    Name of a referenced component in the model hierarchy of the top-level model, such as a referenced model, specified as a character vector or string scalar.

    Example: "slexVariantManagementExternalPlantMdlRef"

    Data Types: char | string

    Output Arguments

    collapse all

    Name of variant configuration used by referenced component, returned as a character vector or string scalar.

    Version History

    Introduced in R2023b

    See Also

    | |

    Topics