getDataDefault

Get default storage class or storage class property setting for model data category

Since R2020b

Syntax

propertyValue = getDataDefault(coderMapObj,elementCategory,mapProperty)

Description

propertyValue = getDataDefault(coderMapObj,elementCategory,mapProperty) returns the value from the code mappings of the specified property for the specified data category.

You cannot specify default data interfaces for models with an attached Embedded Coder Dictionary that defines a service interface configuration.

Examples

Programmatically Get and Set Data Defaults in Code Mappings of Simulink$${}^{\circledR }$$ Models

Use the programmatic interface to get and set the data defaults in the code mappings configuration of a Simulink model.

To interactively observe how your commands are reflected in the Code Mappings editor, make sure the Code Mappings editor is open with the Data Defaults tab selected. To learn how to open the Code Mappings editor, see Open the Code Mappings Editor – C.

Open the model CoderMapAPI.

simulinkModel = "CoderMapAPI";
open_system(simulinkModel);

Retrieve the code mappings object of the model.

codeMapObj = coder.mapping.api.get(simulinkModel);

Set the storage class of all root-level ports to Model default so that their generated code is determined by the value you set for Data Defaults.

setInport(codeMapObj,find(codeMapObj,"Inport"),StorageClass="Model default")
setOutport(codeMapObj,find(codeMapObj,"Outport"),StorageClass="Model default")

Determine the default storage classes for Input and output ports.

inPortDefaultStorageClass = getDataDefault(codeMapObj,"Inports","StorageClass")

inPortDefaultStorageClass = 
'ImportedExtern'

outPortDefaultStorageClass = getDataDefault(codeMapObj,"Outports","StorageClass")

outPortDefaultStorageClass = 
'ImportedExternPointer'

Generate code from the model.

evalc("slbuild(simulinkModel)");

Root-level ports with ImportedExtern and ImportedExternPointer storage classes are declared in the generated private header file of the model in separate sections.

Store the name of the header file.

priv_h_file = fullfile(simulinkModel+"_grt_rtw",simulinkModel+"_private.h")

priv_h_file = 
"CoderMapAPI_grt_rtw/CoderMapAPI_private.h"

These are the declarations of the root-level ports in the header file:

/* Data with Imported storage */
extern real_T in_port_1;               /* '<Root>/in_port_1' */
extern real_T in_port_2;               /* '<Root>/in_port_2' */
extern real_T in_port_3;               /* '<Root>/in_port_3' */
extern real_T in_port_4;               /* '<Root>/in_port_4' */

/* Data with Imported storage (pointer) */
extern real_T *out_port_1;             /* '<Root>/out_port_1' */
extern real_T *out_port_2;             /* '<Root>/out_port_2' */
extern real_T *out_port_3;             /* '<Root>/out_port_3' */
extern real_T *out_port_4;             /* '<Root>/out_port_4' */

To open the header file, enter this command in the MATLAB$${}^{\circledR }$$ Command Window.

edit(priv_h_file)

Switch between the default storage class of input and output ports.

setDataDefault(codeMapObj,"Inports",StorageClass=outPortDefaultStorageClass);
setDataDefault(codeMapObj,"Outports",StorageClass=inPortDefaultStorageClass);

Generate the code from the revised model.

evalc("slbuild(simulinkModel)");

The declarations of the root-level ports are updated in the header file according to the specified storage classes.

/* Data with Imported storage */
extern real_T out_port_1;              /* '<Root>/out_port_1' */
extern real_T out_port_2;              /* '<Root>/out_port_2' */
extern real_T out_port_3;              /* '<Root>/out_port_3' */
extern real_T out_port_4;              /* '<Root>/out_port_4' */

/* Data with Imported storage (pointer) */
extern real_T *in_port_1;              /* '<Root>/in_port_1' */
extern real_T *in_port_2;              /* '<Root>/in_port_2' */
extern real_T *in_port_3;              /* '<Root>/in_port_3' */
extern real_T *in_port_4;              /* '<Root>/in_port_4' */

Input Arguments

coderMapObj — Code mapping object

CodeMapping object

Code mapping object (model code mappings) returned by a call to function coder.mapping.api.get.

Example: myCM

elementCategory — Model data element category

ExternalParameterObjects | GlobalDataStores | Inports | InternalData | ModelParameters | Outports | SharedLocalDataStores

Category of model data elements that you return a property value for.

Example: "Inports"

mapProperty — Code mapping property value to return

StorageClass | Identifier

Code mapping property that you return a value for. Specify one of these property names.

Information to Return	Property Name
Name of storage class	StorageClass
Name of variable for data element in the generated code	Identifier

Example: "Identifier"

Output Arguments

propertyValue — Name of storage class or value of storage class property

character vector | string scalar | Auto | Dictionary default | ExportedGlobal | ImportedExtern | ImportedExternPointer | Model default

The property value is one of these values depending on the category and property that you specify.

Property	Value Returned
StorageClass	One of these values: Auto, , Dictionary default, ExportedGlobal, , ImportedExtern, ImportedExternPointer,

Data Types: char | string

Version History

Introduced in R2020b