Custom Storage Classes (Real-Time Workshop Embedded Coder)

Real-Time Workshop Embedded Coder

Class-Specific Storage Class Attributes

Some custom storage classes have attributes that are exclusive to the class. These attributes are made visible as members of the RTWInfo.CustomAttributes field. For example, the BitField class has a BitFieldName attribute (RTWInfo.CustomAttributes.BitFieldName).

Table 4-5 summarizes the storage classes with additional attributes, and the meaning of those attributes. Attributes marked optional have default values and may be left unassigned.

Table 4-5: Additional Properties of Custom Storage Classes
Storage Class
Name
Additional Properties
Description
Optional
(has default)

ExportToFile
FileName
String. Defines the name of the generated header file within which the global variable declaration should reside. If unspecified, the declaration is placed in model_export.h by default.
Y

ImportFromFile
FileName
String. Defines the name of the generated header file which to be used in #include directive.
N

ImportFromFile
IncludeDelimeter
Enumerated. Defines delimiter used for filename in the #include directive. Delimiter is either double quotes (e.g. #include "vars.h") or angle brackets (e.g. #include <vars.h>). The default is quotes.
Y

BitField
BitFieldName
String. Defines name of bit field in which data will be embedded; if unassigned, the name defaults to rt_BitField.
Y

Struct
StructName
String. Defines name of the struct in which data will be embedded; if unassigned, the name defaults to rt_Struct.
Y

GetSet
GetFunction
String. Specifies function call to read data. See GetSet Custom Storage Class for Data Store Memory.

GetSet
SetFunction
String. Specifies function call to write data. See GetSet Custom Storage Class for Data Store Memory.

GetSet
HeaderFile
String. Same as FileName in the ImportFromFile class.

GetSet
IncludeDelimeter
Enumerated. Same as IncludeDelimeter in the ImportFromFile class.

**Table 4-5: Additional Properties of Custom Storage Classes**
Storage Class Name	Additional Properties	Description	Optional (has default)
`ExportToFile`	`FileName`	String. Defines the name of the generated header file within which the global variable declaration should reside. If unspecified, the declaration is placed in `model_export.h` by default.	Y
`ImportFromFile`	`FileName`	String. Defines the name of the generated header file which to be used in `#include` directive.	N
`ImportFromFile`	`IncludeDelimeter`	Enumerated. Defines delimiter used for filename in the `#include` directive. Delimiter is either double quotes (e.g. `#include "vars.h"`) or angle brackets (e.g. `#include <vars.h>`). The default is quotes.	Y
`BitField`	`BitFieldName`	String. Defines name of bit field in which data will be embedded; if unassigned, the name defaults to `rt_BitField`.	Y
`Struct`	`StructName`	String. Defines name of the struct in which data will be embedded; if unassigned, the name defaults to `rt_Struct`.	Y
`GetSet`	`GetFunction`	String. Specifies function call to read data. See GetSet Custom Storage Class for Data Store Memory.
`GetSet`	`SetFunction`	String. Specifies function call to write data. See GetSet Custom Storage Class for Data Store Memory.
`GetSet`	`HeaderFile`	String. Same as `FileName` in the `ImportFromFile` class.
`GetSet`	`IncludeDelimeter`	Enumerated. Same as `IncludeDelimeter` in the `ImportFromFile` class.

Properties of Predefined Custom Storage Classes Other Custom Storage Classes