Main Content

getModelParameter

Get code and calibration configuration from code mappings for model parameters

    Description

    example

    propertyValue = getModelParameter(myCodeMappingObj,modelParameter,property) returns the value of a code mapping property or calibration property for the specified model workspace parameter or model parameter argument. For example, use this function to return the storage class or the calibration access of a calibration property configured for the parameter or parameter argument.

    Examples

    collapse all

    From the model code mappings for model rtwdemo_configrpinterface, get the name of the storage class that is configured for model parameter K1.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    scK1 = getModelParameter(cm,'K1','StorageClass');
    

    From the model code mappings for model rtwdemo_configrpinterface, configure the storage class and identifier for model parameter Table1. To access the identifier configured for a model parameter, use the getModelParameter function.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    setModelParameter(cm, 'Table1', 'StorageClass', 'ExportedGlobal',...
     'Identifier', 'mp_Table1')
    idTable1 = getModelParameter(cm,'Table1','Identifier');
    
    idTable1 =
    
        'mp_Table1'

    From the model code mappings for model rtwdemo_configrpinterface, get the storage class configured for model parameter arguments LOWER and UPPER.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    scLOWER = getModelParameter(cm,'LOWER','StorageClass');
    scUPPER = getModelParameter(cm,'UPPER','StorageClass');
    

    From the model code mappings for model rtwdemo_configrpinterface, get the calibration properties such as calibration access and display identifier configured for model parameter LOWER.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    prop_export = getModelParameter(cm,'LOWER','Export');
    prop_bitmask = getModelParameter(cm,'LOWER','BitMask');
    prop_calaccess = getModelParameter(cm,'LOWER','CalibrationAccess');
    prop_compname = getModelParameter(cm,'LOWER','CompuMethod');
    prop_dispid = getModelParameter(cm,'LOWER','DisplayIdentifier');
    prop_format = getModelParameter(cm,'LOWER','Format');
    

    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 for which to return the code mapping information.

    Example: 'Table1'

    Data Types: char | string

    Code mapping property for which to return a value. 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 ReturnProperty Name
    Name of storage classStorageClass
    Name of variable for the parameter or parameter argument in the generated codeIdentifier
    Name of source definition file that contains definitions for global data that is read by the parameter or parameter argument and external codeDefinitionFile
    Name of get function called by code generated for the parameter or parameter argument GetFunction
    Name of source header file that contains declarations for global data that is read by the parameter or parameter argument and external codeHeaderFile
    Name of model for which the code generator places the definition for the parameter or parameter argument shared by multiple models in a model hierarchy Owner
    Boolean value indicating whether the code generator preserves dimensions of a parameter or parameter argument that is represented as a multidimensional arrayPerserveDimensions
    Name of set function called by code generated for the parameter or parameter argument SetFunction
    Name of structure in generated code for the parameter or parameter argument StructName
    Boolean value indicating whether to export the selected model parameter to a calibration file (a2l)Export
    Mask value in hexadecimal format to extract single bits from the model parameter in a calibration toolBitMask
    Enumeration value indicating the access of calibration. Calibration for an parameter indicates that the parameter can be calibrated and is the default value for the property. NoCalibration indicates that the parameter can be read-only and cannot be calibrated.CalibrationAccess
    Name of the conversion method used during the calibrationCompuMethod
    Optional display name of the model parameter for calibrationDisplayIdentifier
    Specifies the display format of the model parameter being calibrated in a calibration toolFormat

    Example: 'StorageClass'

    Example: 'CalibrationAccess'

    Output Arguments

    collapse all

    Name of the storage class or value of the specified storage class property configured for model parameter or parameter argument .

    Data Types: char

    Introduced in R2020b