Main Content

setModelParameter

Configure model parameter for code and calibration file (a2l) generation

Since R2020b

    Description

    example

    setModelParameter(myCodeMappingObj,modelParameter,Name,Value) configures the specified model parameter or model parameter argument for code and calibration file (a2l) generation. Use this function to map the specified model parameter or model parameter argument to the storage class and storage class property settings that the code generator uses to produce C code. Or, set the calibration access for the parameter.

    Examples

    collapse all

    In the model code mappings for model ConfigurationRapidPrototypingInterface, set the storage class for model parameter K1 to ExportedGlobal.

    openExample("ConfigurationRapidPrototypingInterface");
    cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface");
    setModelParameter(cm,"K1",StorageClass="ExportedGlobal");
    

    In the model code mappings for model ConfigurationRapidPrototypingInterface, set the storage class for model parameters throughout the model to Model default.

    openExample("ConfigurationRapidPrototypingInterface");
    cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface");
    paramHandles = find(cm,"ModelParameters")
    setModelParameter(cm,paramHandles,StorageClass="Model default");
    

    In the model code mappings for model ConfigurationRapidPrototypingInterface, set the storage class for model parameters Table1 and Table2 to ExportedGlobal.

    openExample("ConfigurationRapidPrototypingInterface");
    cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface");
    setModelParameter(cm,"Table1",StorageClass="ExportedGlobal",Identifier="mp_Table1");
    setModelParameter(cm,"Table2",StorageClass="ExportedGlobal",Identifier="mp_Table2");
    

    From the model code mappings for model ConfigurationRapidPrototypingInterface, set the calibration properties configured for the mode parameter argument LOWER.

    openExample("ConfigurationRapidPrototypingInterface");
    cm = coder.mapping.api.get("ConfigurationRapidPrototypingInterface");
    setModelParameter(cm,"LOWER",Export=true);
    setModelParameter(cm,"LOWER",CalibrationAccess="Calibration");
    setModelParameter(cm,"LOWER",CompuMethod="CM_param");
    setModelParameter(cm,"LOWER",DisplayIdentifier="param_lower");
    setModelParameter(cm,"LOWER",Format="%4.2");
    

    Input Arguments

    collapse all

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

    Example: myCM

    Name of the model workspace parameter or model parameter argument to configure.

    Example: "Table1"

    Data Types: char | string

    Name-Value Arguments

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

    Example: StorageClass="ExportedGlobal"

    Storage class to set for the specified model parameter or model parameter argument. The name of a predefined storage class or storage class that is defined in the Embedded Coder Dictionary associated with the model. See Configure Parameters for C Code Generation.

    Name for the variable that represents the model parameter or model parameter argument in the generated code.

    Data Types: char | string

    File name for a C source file that contains definitions for global data read by data elements and external code. Applies to storage classes ExportToFile and Volatile.

    Data Types: char | string

    Name of a get function that a data element calls in the generated code. Applies to storage class GetSet.

    Data Types: char | string

    File name for a C header file that contains declarations for global data read by data elements and external code. Applies to storage classes ExportToFile, GetSet, ImportFromFile, and Volatile.

    Data Types: char | string

    Name of the model that owns global data used by other models in the same model hierarchy. The code generated for the model that owns the data includes the global data definition. Applies to storage classes ExportToFile and Volatile.

    Data Types: char | string

    When model configuration parameter Array layout is set to Row-major, a flag that indicates whether to preserve dimensions of a data element that is represented in generated code as a multidimensional array. Applies to storage classes ExportToFile, GetSet, ImportFromFile, Localizable, and Volatile.

    Data Types: logical

    Name of a set function that a data element calls in the generated code. Applies to storage class GetSet.

    Data Types: char | string

    Name that the code generator uses to identify the structure for a data element in the generated code. Applies to storage classes Bitfield and Struct.

    Data Types: char | string

    Storage class property defined in the Embedded Coder Dictionary. Values that you can specify vary depending on the storage class definition.

    Note

    For an element associated with the custom storage class where Type is set to Other , create a custom attributes class for the custom storage class and associate the custom attributes class with a Boolean property, SupportSILPIL set to true. For more information, see Interfaces That Produce Additional Generated Code.

    Enable this property to generate the model parameter to calibration file (a2l).

    Mask value in hexadecimal format to extract single bits from the model parameter during calibration. This property is applicable only for integers.

    Data Types: hexadecimal

    Select Calibration for the model parameter to enable the calibration. Select NoCalibration to view the value of the model parameter and disable the calibration.

    Name of the method for converting the ECU-internal value to a physical value for easy readability.

    Data Types: char | string

    Optional display name of the model parameter for measurement purpose in the calibration tool, which is different than the model parameter name in the Simulink model.

    Data Types: char | string

    Special display format to be specified for measurement in the calibration tool. This format specification overrules the display format specified in CompuMethod of the model parameter.

    String or character vector containing the name of a parameter tuning service interface defined in the Embedded Coder Dictionary. To use the dictionary default, specify "Dictionary default".

    To configure the parameter tuning service interface, you must attach an Embedded Coder Dictionary that defines a service interface configuration to the model. For more information, see Configure Parameter and Parameter Argument Tuning Service Interfaces for Model Parameters and Model Parameter Arguments.

    Data Types: char | string

    String or character vector containing the name of a parameter argument tuning service interface defined in the Embedded Coder Dictionary. To use the dictionary default, specify "Dictionary default".

    To configure the parameter argument tuning service interface, you must attach an Embedded Coder Dictionary that defines a service interface configuration to the model. For more information, see Configure Parameter and Parameter Argument Tuning Service Interfaces for Model Parameters and Model Parameter Arguments.

    Data Types: char | string

    Version History

    Introduced in R2020b