Storage Class Properties

The property settings for a storage class define how and where the code generator represents data in the generated code. The properties that the user of a storage class can configure vary depending on the storage class. For most individual elements, the user can configure an identifier for naming the data element in the code. To identify properties that the user can configure for predefined storage classes, see the following information on specific storage classes.

When you create a storage class by using the Custom Storage Class Designer, you can choose whether the user of the storage class can specify additional settings. See Allow Users of Storage Class to Specify Property Value (Embedded Coder).

Default Storage Class

By default, the storage class for an individual data element is Auto. By using this default value, you are choosing to have the code generator handle storage class selection and application. In this case, the data element is subject to code generation optimizations, which can eliminate the element from the code or change the representation of the element. If optimizations do not eliminate the data element, the element appears as a field of a standard data structure in the generated code.

When using the Code Mappings editor or the code mappings API, a data element configured with storage class Auto that is not eliminated by optimizations acquires the default code generation settings for the corresponding data category. If you do not specify a code configuration for a category of data elements, the storage class is Default. When a data element category is using this storage class, data elements in that category appear as a field of a standard data structure in the generated code.

Built-in and Predefined Storage Classes

To prevent optimizations from eliminating storage for a data element, you can choose a storage class for the element based on your code generation requirements. Available storage classes include built-in storage classes, predefined storage classes in the Simulink package, and might also include other project-specific storage classes defined in an Embedded Coder Dictionary. If you have special requirements that are not met by the listed storage classes and you are generating code for an ERT-based target, you can define and use a new storage class. See Define Service Interfaces, Storage Classes, Memory Sections, and Function Templates for Software Architecture (Embedded Coder) and Create Storage Classes by Using the Custom Storage Class Designer (Embedded Coder).

For Simulink^® Coder™, you can choose from these built-in and predefined storage classes.

If you have Embedded Coder^®, you can choose from these additional predefined storage classes available in the Simulink package.

These storage classes are examples of storage classes that you can add to an Embedded Coder Dictionary. These examples are defined and made available when you prepare a model for code generation by using the Quick Start tool.

Auto

When you select this storage class, the code generator handles how to represent the data in the generated code and can enable optimizations to operate on the data element, potentially generating more efficient code.

Auto is the default storage class setting for each data element in a model. The data element is subject to code generation optimizations, which can eliminate the element from the code or change the representation of the element. For information about these optimizations, such as those on the Configuration Parameters > Code Generation > Optimization pane, see How Generated Code Stores Internal Signal, State, and Parameter Data.

Optimizations cannot eliminate some data, such as most block states, from the code. The remaining data acquires a default storage class that you specify on the Data Defaults tab of the Code Mappings editor (see Configure Default Code Generation for Data (Embedded Coder)). If a data element cannot be eliminated, the name of the element in the code is based on naming rules that you specify by using model configuration parameters. See Identifier Format Control (Embedded Coder)—requires Embedded Coder.

Default

On the Data Defaults tab of the Code Mappings editor, Default is the default storage class setting for each data element category. If you leave the storage class setting for a category at this value, data elements that are not subject to code generation optimizations appear as a field of a standard data structure. See How Generated Code Stores Internal Signal, State, and Parameter Data.

Model Default

When you configure an individual data element for code generation, use the Model Default storage class to prevent optimizations from eliminating storage for a data element. See How Generated Code Stores Internal Signal, State, and Parameter Data. With this storage class setting, the data element acquires the default storage class that you specify for the corresponding data category on the Data Defaults tab of the Code Mappings editor. The name of the data element in the code is the same as the name in the model.

Dictionary Default

In Embedded Coder, if you link a model to a data dictionary, which includes a coder dictionary that configures default code definitions for categories of data, you can use the Code Mappings editor to apply the dictionary defaults. On the Data Defaults tab, select a category, then set the storage class to Dictionary Default. For more information on configuring a default code mapping in a coder dictionary, see Configure Default Code Mapping in a Shared Dictionary (Embedded Coder).

ExportedGlobal

Use this built-in storage class to generate a global variable definition and declaration. By default, the name of the variable is the name of the data element. The code declares the variable in the generated file model.h, which you can include (#include) in your external code. The code generator does not optimize this global variable from the generated code.

When you use this storage class, you can also configure this property.

For an example that uses this storage class, see C Data Code Interface Configuration for Model Interface Elements.

ImportedExtern, ImportedExternPointer

To make a data element in a model represent a global variable that your external code defines, use the built-in storage class ImportedExtern. The generated algorithmic code uses the variable without defining it.

Generate code that reads from and writes to a global variable defined by your external code. The generated code declares the variable in the generated file model_private.h so that the model entry-point functions can read and write to the variable.

For example, you can apply the storage class ImportedExtern to a signal line, block state, or parameter object. For imported data:

When your external code defines a data element and provides a pointer for accessing that data, use ImportedExternPointer. The generated code reads from and writes to that pointer. The generated code declares the variable in the generated file model_private.h and reads and writes to the data by dereferencing the pointer.

When you use these storage classes, you can also configure this property.

Bitfield

Use this storage class to generate a structure that stores Boolean, fixed-point, or integer data in named bit fields.

When you use this storage class, you can also configure these properties.

For an example that uses this storage class, see Bitfields (Embedded Coder).

CompilerFlag

Use this storage class to support preprocessor conditionals defined by using a compiler flag or option.

If you build the generated code by using Embedded Coder, to specify the compiler option, you can use the model configuration parameter Configuration Parameters > Code Generation > Custom Code > Code information > Defines. See Code Generation Pane: Custom Code: Additional Build Information: Defines.

When you use this storage class, you can also configure this property.

For an example that uses this storage class, see Compile Code Conditionally for Variations of Component Represented Using Variant Block.

Const, Volatile, and ConstVolatile

Use these storage classes to generate a global variable definition and declaration with the const, volatile, or const and volatile type qualifiers.

When you use these storage classes, you can also configure these properties.

For an example that uses this storage class, see Type Qualifiers (Embedded Coder).

Define, ImportedDefine

Use the Define storage class to generate a macro (#define directive) such as #define myParam 5.

Use ImportedDefine to generate code that uses a macro (#define directive) defined in a header file in your external code. For an example, see Macro Definitions (#define) (Embedded Coder).

When you use these storage classes, you can also configure these properties.

Data elements that use this storage class do not appear in the code descriptor API or generated ARXML descriptions. For information about the code descriptor API, see Get Code Description of Generated Code. For information about generating ARXML descriptions, see Generate AUTOSAR C Code and XML Descriptions (AUTOSAR Blockset).

ExportToFile

Generate a global variable definition and declaration to an external file. You can specify the name and placement of the files that define and declare the variable. See Control Placement of Global Data Definitions and Declarations in Generated Files (Embedded Coder).

When you use this storage class, you can also configure these properties.

For an example that uses this storage class, see Definition, Initialization, and Declaration of Parameter Data (Embedded Coder).

FileScope

Use this storage class to generate a global variable definition and declaration that has the static type qualifier. In the generated code, the scope of the variable is limited to the current file, which is typically model.c.

In a model reference hierarchy, if a referenced model uses a parameter object (such as Simulink.Parameter) that you create in the base workspace or a data dictionary, you cannot apply FileScope to the object. As a workaround, move the parameter object into the model workspace of the referenced model. Then, you can use FileScope.

When you use this storage class, you can also configure these properties.

GetSet

Use this storage class to generate code that interacts with data by calling custom accessor functions. Your external code defines the data and provides the function definitions.

When you use this storage class, you can also configure these properties.

For an example that uses this storage class, see Access Data Through Functions with Storage Class GetSet (Embedded Coder).

ImportFromFile

Use this storage class to generate code that reads from and writes to a global variable defined by your external code. ImportFromFile is similar to ExportToFile, but the generated code does not define the variable.

When you use this storage class, you can also configure these properties.

For an example that uses this storage class, see Integrate External Application Code with Code Generated from PID Controller (Embedded Coder).

Localizable

For signals, if possible, minimize the use of global storage by using local variables.

Generating local variables prevents the code generator from removing the variables from the generated code.

When you use this storage class, you can also configure these properties.

For an example that uses this storage class, see Generate Local Variables with Localizable Storage Class (Embedded Coder).

Reusable

Use this storage class to reuse the same variable for multiple independent signals in a model. The code generator stores intermediate calculations of a data path (a series of connected blocks) in a single, reused global variable.

When you use this storage class, you can also configure this property.

For an example that uses this storage class, see Specify Buffer Reuse for Signals in a Path (Embedded Coder).

Struct

Use this storage class to generate a global structure with a name that you can specify.

When you use this storage class, you can also configure these properties.

For an example that uses this storage class, see Organize Parameter Data into a Structure by Using Struct Storage Class (Embedded Coder) and Structures of Signals (Embedded Coder).

MultiInstance

To generate unstructured variables for single-instance data and structures for multi-instance data, use this storage class. When you apply this storage class to a data item, the Embedded Coder Dictionary determines if it is a single-instance storage class or a multi-instance storage class. The dictionary determines the type of class by the type of data and by the context of the model within the model reference hierarchy. You can duplicate this storage class to create a copy that you can edit.

When you apply this storage class to an individual data element, you can also configure the Identifier property. The Identifier property is an identifier string that the code generator uses to name the data element in the generated code.

For an example that uses this storage class, see Flexible Storage Class for Different Model Hierarchy Contexts (Embedded Coder).

ParamStruct, SignalStruct

Use these storage classes to generate global structures that contain parameter and signal or state data, respectively. In a hierarchy of components (referenced models or atomic subsystems), you can use these storage classes to create a corresponding hierarchy of structures. These storage classes appear in the Code Mappings editor only after preparing a model for code generation by using the Quick Start tool.

These storage classes are available only for model-owned data.

When you use these storage classes, you can also configure this property.

Storage Class Limitations