Main Content

setState

Configure block states for code and calibration file (a2l) generation

    Description

    example

    setState(myCodeMappingObj,block,Name,Value) configures specified block states for code and calibration file (a2l) generation. Use this function to map specified block states 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 for the states.

    Examples

    collapse all

    In the model code mappings for model rtwdemo_configrpinterface, set the storage class for the state X of Unit Delay block Delay to ExportedGlobal.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    setState(cm,'rtwdemo_configrpinterface/Delay','StorageClass','ExportedGlobal');
    

    In the model code mappings for model rtwdemo_configrpinterface, configure the storage class for block states throughout the model to Model default.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    blockHandles = find(cm,'States');
    setState(cm,blockHandles,'StorageClass','Model default');
    

    In the model code mappings for model rtwdemo_configrpinterface, configure the code identifier for the state X of Unit Delay block Delay to dstate_X.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    blockHandles = find(cm,'States');
    setState(cm,blockHandle,'Identifier','dstate_X');
    

    From the model code mappings for model rtwdemo_configrpinterface, set the calibration properties configured for state X of Unit Delay block Delay.

    open_system('rtwdemo_configrpinterface');
    cm = coder.mapping.api.get('rtwdemo_configrpinterface');
    state = find(cm,'State');
    setState(cm,state,'Export',true);
    setState(cm,state,'CalibrationAccess','Calibration');
    setState(cm,state,'CompuMethod','CM_state');
    setState(cm,state,'DisplayIdentifier','state_X');
    setState(cm,state,'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

    Path or handle of the block containing the state to configure. To specify multiple block states, use a cell array.

    Example: blockHandle

    Data Types: char | string | block_handle | cell

    Name-Value 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 block state. The name of a predefined storage class or storage class that is defined in the Embedded Coder Dictionary associated with the model. See Configure Block States for C Code Generation.

    Name for the variable that represents the block state in the generated code.

    Data Types: char | string

    Enable this property to generate the block state to calibration file (a2l).

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

    Data Types: hexadecimal

    Select Calibration for the block state to enable the calibration. Select NoCalibration to view the value of the block state 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 block state for the measurement purpose in the calibration tool, which is different than the block state 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 state.

    Introduced in R2020b