getDataDefault

R2026b

Get default code settings for data category

Syntax

value = getDataDefault(myCoderDictionaryObj, category, property)

Description

value = getDataDefault(myCoderDictionaryObj, category, property) returns the value from the code mappings of the specified property for the specified data category.

Examples

Use Coder Dictionary Mapping Object to Configure Dictionary Data Defaults

View and modify data defaults of an Embedded Coder^® dictionary configured with data interface configuration.

Use the function Simulink.data.dictionary.create to create the dictionary file dataDict.sldd and the associated Simulink.data.Dictionary object. Then use the function coder.dictionary.create to create the data interface Embedded Coder dictionary object, and store handles to the objects in variables.

dictFile = "dataDict.sldd";
simDictObj = Simulink.data.dictionary.create(dictFile);
ecoderDataDictObj = coder.dictionary.create(dictFile,"DataInterface");

Use the function coder.mapping.api.get() with the dictionary file name to get a handle to the mapping object of the dictionary mapping object and store it in the variable dictMapObj.

dictMapObj = coder.mapping.api.get(dictFile);

Use the function setDataDefault to set the default dictionary value for the storage class of outports, then use the function getDataDefault to verify that the default has been updated.

setDataDefault(dictMapObj,"Outports",StorageClass="ExportedGlobal")
getDataDefault(dictMapObj,"Outports","StorageClass")

ans = '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'

property — Code mapping property value to return

StorageClass | Identifier | DefinitionFile | GetFunction | HeaderFile | MemorySection | Owner | PreserveDimensions | SetFunction | StructName | storage class property name

Code mapping property that you return a value for. Specify one of these property names or a property name for a storage class defined in the Embedded Coder Dictionary .

Information to Return	Property Name
Name of storage class	StorageClass
Name of variable for data element in the generated code	Identifier
Name of source definition file that contains definitions for global data that is read by the data element and external code	DefinitionFile
Name of get function called by code generated for the data element	GetFunction
Name of source header file that contains declarations for global data that is read by the model data element and external code	HeaderFile
Character vector or string scalar that names a memory section for a model defined in the Embedded Coder Dictionary.	MemorySection
Name of model for which the code generator places the definition for data element shared by multiple models in a model hierarchy	Owner
Boolean value indicating whether code generator preserves dimensions of data that is represented as a multidimensional array	PerserveDimensions
Name of set function called by code generated for data element	SetFunction
Name of structure in generated code for data element	StructName

Example: 'Identifier'

Output Arguments

value — Code mapping property value of category

character vector

The code mapping property value of the specified category, returned as a character vector.

Version History

Introduced in R2021a