coder.Dictionary class

Package: coder

Configure Embedded Coder Dictionary

Description

An object of the coder.Dictionary class represents an Embedded Coder Dictionary. Use the object to perform operations on the Embedded Coder Dictionary, such as load packages of definitions and gain access to sections of the dictionary.

A coder.Dictionary object contains three coder.dictionary.Section objects, which represent the sections of an Embedded Coder Dictionary: Storage Classes, Memory Sections, and Function Customization Templates. A coder.dictionary.Section object contains coder.dictionary.Entry objects, which represent the definitions stored in that section of the Embedded Coder Dictionary. The name of the section identifies the type of code definitions that the section contains. To access the sections of an Embedded Coder Dictionary, use a coder.Dictionary object. To access the dictionary entries within the section, use a coder.dictionary.Section object.

Creation

The functions coder.dictionary.create and coder.dictionary.open create a coder.Dictionary object.

Methods

expand all

Public Methods

`getSection`	Return `coder.dictionary.Section` object that represents Embedded Coder Dictionary section
`getSections`	Return `coder.dictionary.Section` objects of an Embedded Coder Dictionary
`loadPackage`	Load package of code definitions into Embedded Coder Dictionary
`unloadPackage`	Unload package of code definitions from Embedded Coder Dictionary
`refreshPackage`	Refresh package definitions in Embedded Coder Dictionary
`resetToDefault`	Restore Embedded Coder Dictionary to default state
`valid`	Determine whether `coder.Dictionary` object represents a valid Embedded Coder Dictionary
`empty`	Determine whether Embedded Coder Dictionary is empty

Examples

collapse all

Create Embedded Coder Dictionary in Simulink Data Dictionary

Create a data dictionary to contain an Embedded Coder Dictionary.

dataDictionary = Simulink.data.dictionary.create('DataDictionary.sldd');

Create an Embedded Coder Dictionary in the data dictionary and use a coder.Dictionary object to represent the Embedded Coder Dictionary.

coderDictionary = coder.dictionary.create(dataDictionary)

coderDictionary = 

  Dictionary with Sections:

                    StorageClasses: [1×1 coder.dictionary.Section]
                    MemorySections: [1×1 coder.dictionary.Section]
    FunctionCustomizationTemplates: [1×1 coder.dictionary.Section]

The Embedded Coder Dictionary contains three coder.dictionary.Section objects, each of which represents a section of the dictionary.

Documentation