getModelVariantControl

Get code configuration from code mappings for Simulink.VariantControl object

Since R2025a

Syntax

propertyValue = getModelVariantControl(codeMappingObj,variantControl,property)

Description

propertyValue = getModelVariantControl(codeMappingObj,variantControl,property) returns the value of a code mapping property or calibration property for the specified Simulink.VariantControl object. Use this function to return the storage class or the calibration access of a calibration property configured for the variant control. Specifying code generation attributes for a Simulink.VariantControl object using code mappings is supported when the object is defined in the model workspace and its Value property is set to a Simulink.Parameter object.

Examples

Get Storage Class Configured for Simulink.VariantControl Object

From the model code mappings for the model slexVariantParameterCodeMappings, get the name of the storage class of variant control Wiper.

openExample("simulinkcoder/ConfigureCodeGenForVariantParametersInModelWorkspaceExample");
cm = coder.mapping.api.get("slexVariantParameterCodeMappings");
getModelVariantControl(cm,"Wiper","StorageClass");

Input Arguments

codeMappingObj — Code mapping

CodeMapping object

Code mapping object (model code mappings) returned by a call to function coder.mapping.api.get.

variantControl — Name of Simulink.VariantControl object

character vector | string scalar

Name of Simulink.VariantControl object specified as a character vector or string scalar.

Example: "varCtrl"

Data Types: char | string

property — Code mapping property name

StorageClass | Identifier | DefinitionFile | GetFunction | HeaderFile | Owner | PreserveDimensions | SetFunction | StructName | storage class property name | Export | BitMask | CalibrationAccess | CompuMethod | DisplayIdentifier | Format | ParameterTuningService | ParameterArgumentTuningService

Code mapping property name. The getModelVariantControl function returns the value of this property. For a storage class defined in the Embedded Coder Dictionary associated with the model, specify a property name or one of these property names.

Information to Return	Property Name
Name of storage class	StorageClass
Name of variable for the variant control in the generated code	Identifier
Name of source definition file that contains definitions for global data that is read by the variant control and external code	DefinitionFile
Name of get function called by code generated for the variant control	GetFunction
Name of source header file that contains declarations for global data that is read by the variant control and external code	HeaderFile
Name of model for which the code generator places the definition for the variant control shared by multiple models in a model hierarchy	Owner
Name of set function called by code generated for the variant control	SetFunction
Name of structure in generated code for the variant control	StructName
Boolean value indicating whether the code generator preserves dimensions of a variant control that is represented as a multidimensional array	PerserveDimensions
Name of set function called by code generated for the variant control	SetFunction
Name of structure in generated code for the variant control	StructName
Boolean value indicating whether to export the selected variant control to an A2L calibration file	Export
Mask value in hexadecimal format to extract single bits from the variant control in a calibration tool	BitMask
Enumeration value indicating the access of calibration: Calibration for a variant control indicates that the variant control can be calibrated and is the default value for the property. NoCalibration indicates that the variant control can be read-only and cannot be calibrated.	CalibrationAccess
Name of the conversion method used during the calibration	CompuMethod
Optional display name of the variant control for calibration	DisplayIdentifier
Display format of the variant control being calibrated in a calibration tool	Format
Name of parameter argument tuning service defined in Embedded Coder Dictionary	ParameterArgumentTuningService
Name of parameter tuning service defined in Embedded Coder Dictionary	ParameterTuningService

Example: "StorageClass"

Output Arguments

propertyValue — Name of storage class or value of storage class property

character vector

Name of the storage class or value of the specified storage class property configured for the variant control, returned as a character vector.

Version History

Introduced in R2025a