Exponenta Banner

setModelParameter

Configure model parameter for code generation

collapse all in page

    Syntax

    setModelParameter(myCodeMappingObj,modelParameter,Name,Value)

    Description

    example

    setModelParameter(myCodeMappingObj,modelParameter,Name,Value) configures the specified model parameter or model parameter argument for code 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 for the parameter or parameter argument.

    Examples

    collapse all

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

    cm = coder.mapping.api.get('myConfigModel');
setModelParameter(cm,'K1','StorageClass','ExportedGlobal');

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

    cm = coder.mapping.api.get('myConfigModel');
paramHandles = find(cm,'ModelParameters')
setModelParameters(cm,paramHandles,'StorageClass','Model default');

    In the model code mappings for model myConfigModel, set the storage class for model parameters Table1 and Table2 to ExportedGlobal. Set the identifier for the variables representing the parameters in the generated code to mp_Table1 and mp_Table2.

    cm = coder.mapping.api.get('myConfigModel');
setModelParameter(cm,'Table1','StorageClass','ExportedGlobal',...
   'Identifier','mp_Table1');
setModelParameter(cm,'Table2','StorageClass','ExportedGlobal',...
   'Identifier','mp_Table2');

    In the model code mappings for model myConfigModel, set the storage class for model parameter arguments LOWER and UPPER to ExportedGlobal. Set the identifiers for the variables representing the parameter arguments in the generated code to arg_LOWER and arg_UPPER.

    cm = coder.mapping.api.get('myConfigModel');
setModelParameter(cm,'LOWER','StorageClass','ExportedGlobal',...
   'Identifier','arg_LOWER');
setModelParameter(cm,'UPPER','StorageClass','ExportedGlobal',...
   'Identifier','arg_UPPER');

    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 Pair Arguments

    Example: 'StorageClass' 'ExportedGlobal'

    Specify comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments as Name1,Value1,…,NameN,ValueN. The order of the name and value pair arguments does not matter.

    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, 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.

    See Also

    | | | | |

    Topics

    Introduced in R2020b

    Embedded Coder Documentation

    Support