setDataDefault

Set default code settings for data category

Since R2021a

Syntax

setDataDefault(myCoderDictionaryObj,category,Name,Value)

Description

setDataDefault(myCoderDictionaryObj,category,Name,Value) sets the default storage class and storage class property values in the code mappings for the specified category of model data.

Examples

Configure default code settings for a data category in a data dictionary

Use the coder.mapping.api.get function to access the CoderDictionary object associated with the data dictionary.

cm = coder.mapping.api.get('codeDefinitions.sldd');

To see the storage class of root-level inports for the dictionary, use the getDataDefault function.

value = getDataDefault(cm, 'Inports', 'StorageClass')

value =

    'Default'

The dictionary uses the default storage class for inports.

To configure the storage class, use the setDataDefault function.

setDataDefault(cm, 'Inports', 'StorageClass', 'ExportedGlobal')

To verify that the storage class of inports is now set to ExportedGlobal, use the getDataDefault function.

value = getDataDefault(cm, 'Inports', 'StorageClass')

value =

    'ExportedGlobal'

Input Arguments

myCoderDictionaryObj — Coder dictionary object

CoderDictionary object

Coder dictionary object returned by a call to function coder.mapping.api.get.

category — Model data element category

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

Category of data elements to return a property value for.

Example: 'Inports'

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.

StorageClass — Name of storage class

Auto | Bitfield | CompileFlag | Const | ConstVolatile | Define | Dictionary default | ExportedGlobal | ExportToFile | FileScope | GetSet | ImportedDefine | ImportedExtern | ImportedExternPointer | ImportFromFile | Localizable | Model default | Struct | Volatile | storage class name

Storage class to set for the specified data element category. The name of a predefined storage class or storage class that is defined in the Embedded Coder Dictionary associated with the model. Values that you can specify vary depending on the category that you specify. See Choose Storage Class for Controlling Data Representation in Generated Code.

Example: 'StorageClass','ImportedExtern'

DefinitionFile — C source file

character vector | string scalar

File name for a C source file that contains definitions for global data read by data elements and external code. Applies to storage classes Const, ConstVolatile, ExportToFile, and Volatile.

Example: 'DefinitionFile','myDataDefs.c'

Data Types: char | string

GetFunction — Name of get function

character vector | string scalar

Name of a get function that a data element calls in the generated code. Applies to storage class GetSet.

Example: 'GefFunction','myDataGetFunction'

Data Types: char | string

HeaderFile — C header file

character vector | string scalar

File name for a C header file that contains declarations for global data read by data elements and external code. Applies to storage classes Const, ConstVolatile, Define, ExportToFile, GetSet, ImportedDefine, ImportFromFile, and Volatile.

Example: 'HeaderFile','myDataDecl.h'

Data Types: char | string

MemorySection — Name of memory section

character vector | string scalar

Name of a memory section that is defined in the Embedded Coder Dictionary associated with the model.

Example: 'MemorySection','myFastMem'

Data Types: char | string

Owner — Owner of global data

character vector | string scalar

Name of the model that owns global data, which is used by other models in the same model hierarchy. The code generated for the model that owns the data includes the global data definition. Applies to storage classes Const, ConstVolatile, ExportToFile, and Volatile.

Example: 'Owner','myModelA'

Data Types: char | string

PreserveDimensions — Boolean flag indicating whether to preserve dimensions of multidimensional arrays

True | False

When model configuration parameter Array layout is set to Row-major, a flag that indicates whether to preserve dimensions of a data element represented in generated code as a multidimensional array. Applies to storage classes Const, ConstVolatile, , ExportToFile, FileScope, ImportFromFile, Localizable, and Volatile.

Example: 'PreserveDimensions','True'

Data Types: logical

SetFunction — Name of set function

character string | string scalar

Name of a set function that a data element calls in the generated code. Applies to storage class GetSet.

Example: 'SetFunction','myDataSetFunction'

Data Types: char | string

StructName — Name of structure

character vector | string scalar

Name that the code generator uses to identify the structure for a data element in the generated code. Applies to storage classes Bitfield and Struct.

Example: 'StructName','myDataStruct'

storageClassPropertyName — Value of storage class property

depends on property definition

Storage class property defined in the Embedded Coder Dictionary. Values that you can specify vary depending on the storage class definition.

Data Types: char | string

Version History

Introduced in R2021a