Пакет: coder.dictionary
Сконфигурируйте Словарное определение Embedded Coder
Объект coder.dictionary.Entry класс представляет одно определение Словаря Embedded Coder. В этом API объект называется записью. Информацией, которую представляет объект, является определение. В этой документации определение обращается к определению объекта записи.
coder.Dictionary объект содержит три coder.dictionary.Section объекты, которые представляют разделы Словаря Embedded Coder: Классы памяти, Разделы Памяти и Функциональные Шаблоны настройки. coder.dictionary.Section объект содержит coder.dictionary.Entry объекты, которые представляют определения, сохраненные в том разделе Словаря Embedded Coder. Имя раздела идентифицирует тип определений кода, которые содержит раздел. Чтобы получить доступ к разделам Словаря Embedded Coder, используйте coder.Dictionary объект. Чтобы получить доступ к словарным статьям в разделе, используйте coder.dictionary.Section объект.
coder.dictionary.Entry объект имеет эти свойства.
Name — Имя определения кодаИмя словарного определения кодера, которое представляет запись. Имя должно быть уникальным среди определений в разделе словаря.
DataSource — Местоположение определения кодаМестоположение определения кода. Это свойство доступно только для чтения.
Built-in — Если Simulink®.
Имя модели — Заданный в модели Simulink.
Имя словаря — Заданный в словаре данных Simulink.
Имя пакета — Заданный в пакете Simulink или в пользовательском пакете.
Чтобы получить доступ к свойствам определения кода, которое представляет запись, используйте getAvailableProperties, get, и set методы. Каждому типу определения кода перечислили доступные свойства.
Name — Имя класса памятиStorageClass1 (значение по умолчанию) | вектор символов | строковый скалярИмя класса памяти. Имя должно быть уникальным среди классов памяти в словаре.
Для списков встроенных и классов памяти в качестве примера, которые обеспечивает Simulink, смотрите, Выбирают Storage Class for Controlling Data Representation in Generated Code.
Description — Цель и функциональность класса памятиПользовательский текст, который можно использовать, чтобы описать цель и функциональность класса памяти.
DataSource — Местоположение определения кодаМестоположение определения кода. Это свойство доступно только для чтения.
Built-in — Если Simulink.
Имя модели — Заданный в модели Simulink.
Имя словаря — Заданный в словаре данных Simulink.
Имя пакета — Заданный в пакете Simulink или в пользовательском пакете.
DataAccess — Спецификация, чтобы получить доступ к даннымDirect (значение по умолчанию) | FunctionСпецификация, чтобы получить доступ к данным, сопоставленным с моделью. Доступ к данным непосредственно (Direct) или через настраиваемый get и set функции (Function). Для получения дополнительной информации см. Доступ к данным Через Функции при помощи Классов памяти в Словаре Embedded Coder.
Установка этого свойства к Function:
Наборы DataScope к Imported.
Средние значения, что вы не можете задать свойства мультиэкземпляра.
Включает эти свойства:
AccessMode
AllowedAccess
GetFunctionName
SetFunctionName
Устанавливает PreserveDimensions свойство к false. Чтобы сохранить размерности многомерных массивов в сгенерированном коде, установите DataAccess к Direct.
DataScope — Спецификация, чтобы сгенерировать определение данныхExported (значение по умолчанию) | ImportedСпецификация, что сгенерированный код задает данные (Exported) или импорт (Imported) определение данных из внешнего кода. Встроенные классы памяти и классы памяти в пакетах, таких как Simulink могут использовать другие опции осциллографа, такие как File.
Установка этого свойства к Imported:
Отключает DefinitionFile. Чтобы включать ваш внешний файл исходного кода в процесс сборки, используйте параметры конфигурации модели. Для примера смотрите, Конфигурируют Интерфейс Данных.
Средние значения, что вы не можете установить HeaderFile к $N.h, хотя можно использовать $N лексема.
Установить это свойство на Exported, необходимо использовать одну из лексем $N или $R в значении HeaderFile.
Header File — Имя заголовочного файла, который объявляет данные$N.h (значение по умолчанию) | вектор символов | строковый скалярИмя заголовочного файла, который объявляет данные в виде имени или называющий правило. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Имя связанного элемента данных |
$G | Имя класса памяти |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
Если вы устанавливаете DataScope к Exported, необходимо использовать одну из лексем $R или $N в значении этого свойства.
Если вы устанавливаете DataScope к Imported, вы не можете установить значение этого свойства к $N.h, но можно использовать $N лексема.
Definition File — Имя исходного файла, который задает данные$N.c (значение по умолчанию) | вектор символов | строковый скалярИмя исходного файла, который задает данные в виде имени или называющий правило. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Имя связанного элемента данных |
$G | Имя класса памяти |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
Установка DataScope к Imported отключает DefinitionFile. Чтобы включать ваш внешний файл исходного кода в процесс сборки, используйте параметры конфигурации модели. Для примера смотрите, Конфигурируют Интерфейс Данных.
AccessMode — Спецификация, чтобы получить доступ к данным через функцииValue (значение по умолчанию) | PointerСпецификация для класса памяти, чтобы получить доступ к данным, сопоставленным с моделью через функции при помощи Value или Pointer. Для получения дополнительной информации см. Доступ к данным Через Функции при помощи Классов памяти в Словаре Embedded Coder.
Это свойство включено только, когда вы устанавливаете DataAccess к Function.
AllowedAccess — Спецификация, чтобы предоставить доступ к данным через функцииReadWrite (значение по умолчанию) | ReadOnly | WriteOnlyСпецификация для класса памяти, чтобы позволить чтение и запись (ReadWrite), только для чтения (ReadOnly), или только для записи (WriteOnly) доступ к данным.
Это свойство включено только, когда вы устанавливаете DataAccess к Function.
GetFunctionName — Имя get функция, которая выбирает связанные данныеget_$N$M (значение по умолчанию) | вектор символов | строковый скалярИмя get функция, которая выбирает связанные данные в виде имени или называющий правило. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$N | Имя связанного элемента данных (требуется) |
$R | Имя корневой модели |
$M | Исказите текст, который гарантирует уникальность |
$U | Пользовательский текст лексемы. Смотрите Управление форматом Идентификатора. |
Это свойство включено только, когда вы устанавливаете DataAccess к Function и AllowedAccess к ReadWrite или ReadOnly.
SetFunctionName — Имя set функция, которая изменяет связанные данныеset_$N$M (значение по умолчанию) | вектор символов | строковый скалярИмя set функция, которая выбирает модифицированные данные в виде имени или называющий правило. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$N | Имя связанного элемента данных (требуется) |
$R | Имя корневой модели |
$M | Исказите текст, который гарантирует уникальность |
$U | Пользовательский текст лексемы. Смотрите Управление форматом Идентификатора. |
Это свойство включено только, когда вы устанавливаете DataAccess к Function и AllowedAccess к ReadWrite или WriteOnly.
DifferentInstanceDataSettings — Спецификация, чтобы присвоить настройки отдельной системы хранения для данных одно экземпляра и данных мультиэкземпляраfalse (значение по умолчанию) | trueСпецификация для класса памяти, чтобы использовать или настройки устройства хранения данных, что вы указываете для данных одно экземпляра или настроек, что задаете для данных мультиэкземпляра. Когда вы применяете класс памяти к элементу данных, Словарь Embedded Coder определяет, является ли это класс хранения единственного экземпляра или класс памяти мультиэкземпляра типом данных и контекстом модели в иерархии модели - ссылки.
Выбор этого свойства включает свойства SingleInstanceStorageType, MultiInstanceStorageType, и MultiInstanceStructureTypeName, MultiInstanceStructureInstanceName.
StorageType — Спецификация к агрегированным данным в структуруUnstructured (значение по умолчанию) | StructuredСпецификация, чтобы агрегировать данные, которые используют класс памяти в структуру в сгенерированном коде. Каждый элемент данных появляется в коде как поле структуры. Чтобы создать структуру, используйте Structured.
Установка этого свойства к Structured включает StructureTypeName и StructureInstanceName.
StructureTypeName — Имя типа структуры$R$N$G$M (значение по умолчанию) | вектор символов | строковый скалярИмя структуры вводит в сгенерированном коде в виде имени или правила именования. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Базовое имя присоединенной функции, такой как step |
$G | Имя класса памяти |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
$M | Искажающий имя вставленный текст, при необходимости, чтобы избежать столкновений имени |
Установка StorageType к Structured включает это свойство.
StructureInstanceName — Имя переменной структуры$G$N$M (значение по умолчанию) | вектор символов | строковый скалярИмя переменной структуры в сгенерированном коде в виде имени или правила именования. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Базовое имя присоединенной функции, такой как step |
$G | Имя класса памяти |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
$M | Искажающий имя вставленный текст, при необходимости, чтобы избежать столкновений имени |
Установка StorageType к Structured включает это свойство.
SingleInstanceStorageType — Спецификация к совокупным данным одно экземпляра в структуруStructured (значение по умолчанию) | UnstructuredСпецификация, чтобы агрегировать данные одно экземпляра, которые используют класс памяти в структуру в сгенерированном коде. Каждый элемент данных появляется в коде как поле структуры. Чтобы создать структуру, используйте Structured.
Установка свойства UseDifferentPropSettingsForInstanceData к true включает это свойство.
Установка этого свойства к Structured включает свойства SingleInstanceStructureTypeName и SingleInstanceStructureInstanceName.
SingleInstanceStructureTypeName — Имя структуры вводит для данных одно экземпляра$R$N$G$M (значение по умолчанию) | вектор символов | строковый скалярИмя структуры вводит в сгенерированном коде в виде имени или правила именования. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Базовое имя присоединенной функции, такой как step |
$G | Имя класса памяти |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
$M | Искажающий имя вставленный текст, при необходимости, чтобы избежать столкновений имени |
Установка SingleInstanceStorageType к Structured включает это свойство.
SingleInstanceStructureInstanceName — Имя переменной структуры для данных одно экземпляра$G$N$M (значение по умолчанию) | вектор символов | строковый скалярИмя переменной структуры в сгенерированном коде в виде имени или правила именования. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Базовое имя присоединенной функции, такой как step |
$G | Имя класса памяти |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
$M | Искажающий имя вставленный текст, при необходимости, чтобы избежать столкновений имени |
Установка SingleInstanceStorageType к Structured включает это свойство.
MultiInstanceStorageType — Спецификация к совокупным данным мультиэкземпляра в структуруStructured (значение по умолчанию)Спецификация, чтобы агрегировать данные одно экземпляра, которые используют класс памяти в структуру в сгенерированном коде. Каждый элемент данных появляется в коде как поле структуры. Вы не можете изменить значение этого свойства.
Установка свойства UseDifferentPropSettingsForInstanceData к true включает это свойство.
MultiInstanceStructureTypeName — Имя структуры вводит для данных мультиэкземпляра$R$N$G$M (значение по умолчанию) | вектор символов | строковый скалярИмя структуры вводит в сгенерированном коде в виде имени или правила именования. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Базовое имя присоединенной функции, такой как step |
$G | Имя класса памяти |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
$M | Искажающий имя вставленный текст, при необходимости, чтобы избежать столкновений имени |
Установка свойства UseDifferentPropSettingsForInstanceData к true включает это свойство.
Если вы устанавливаете свойство DataAccess к FunctionВы не можете задать это свойство.
MultiInstanceStructureInstanceName — Имя переменной структуры для данных мультиэкземпляра$G$N$M (значение по умолчанию) | вектор символов | строковый скалярИмя переменной структуры в сгенерированном коде в виде имени или правила именования. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Базовое имя присоединенной функции, такой как step |
$G | Имя класса памяти |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
$M | Искажающий имя вставленный текст, при необходимости, чтобы избежать столкновений имени |
Установка свойства UseDifferentPropSettingsForInstanceData к true включает это свойство.
Если вы устанавливаете свойство DataAccess к FunctionВы не можете задать это свойство.
DataInit — Как инициализировать данныеDynamic (значение по умолчанию) | Static | NoneСпецификация, что сгенерированные коды инициализируют данные.
Dynamic — Сгенерированный код инициализирует данные как часть функции точки входа инициализации модели.
Static — Сгенерированный код инициализирует данные в том же операторе, который задает и выделяет память для данных. Оператор присваивания появляется наверху .c или .cpp исходный файл, за пределами функции.
None — Сгенерированный код не инициализирует данные.
Если вы устанавливаете Const к true, вы не можете установить это свойство на Dynamic.
Установка этого свойства к Dynamic устанавливает свойство Const к false.
MemorySection — Местоположение в памяти, чтобы выделить данныеNone (значение по умолчанию) | coder.dictionary.Entry объектМестоположение в памяти, чтобы выделить данные в виде coder.dictionary.Entry объект, который представляет раздел memory, который существует в Словаре Embedded Coder. Для получения информации о разделах памяти смотрите Данные об Управлении и Функциональное Размещение в Памяти Вставкой Прагм.
PreserveDimensions — Спецификация, чтобы сохранить размерности многомерных массивовfalse (значение по умолчанию) | trueСпецификация для класса памяти, чтобы сохранить размерности многомерных массивов в сгенерированном коде. Для получения дополнительной информации смотрите Размерности Заповедника Многомерных массивов в Сгенерированном коде.
Const — Спецификация, чтобы применить const спецификаторfalse (значение по умолчанию) | trueСпецификация, чтобы применить const спецификатор к данным.
Если вы выбираете это свойство, вы не можете установить DataInit к Dynamic.
Установка DataInit к Dynamic \sets это свойство к false.
Volatile — Спецификация, чтобы применить volatile спецификаторfalse (значение по умолчанию) | trueСпецификация, чтобы применить volatile спецификатор к данным.
OtherQualifier — Спецификация, чтобы применить пользовательский спецификаторСпецификация, чтобы применить пользовательский спецификатор к данным. Например, некоторые архитектуры памяти поддерживают спецификаторы far и huge.
Не используйте это свойство применить ключевое слово static. Вместо этого используйте встроенный класс памяти FileScope, который вы не можете применить с редактором Отображений Кода. Смотрите Выбирают Класс памяти для Управления Представлением данных в Сгенерированном коде.
AccessibleByParameters — Позволить ли использование с параметрами моделиfalse (значение по умолчанию) | trueСпецификация, указывающая, позволить ли использование класса памяти с параметрами модели.
Установка DataInit к Static наборы это свойство к true.
Установка DataInit к Dynamic наборы это свойство к false.
Чтобы установить значение этого свойства, устанавливает DataInit к None.
AccessibleBySignals — Позволить ли использование с сигналами моделиtrue (значение по умолчанию) | falseСпецификация, указывающая, позволить ли использование класса памяти с сигналами модели.
Установка DataInit к Dynamic наборы это свойство к true.
Установка DataInit к Static наборы это свойство к false.
Чтобы установить значение этого свойства, устанавливает DataInit к None.
Name — Имя шаблона функцииFunctionTemplate1 (значение по умолчанию) | вектор символов | строковый скалярИмя шаблона. Имя должно быть уникальным среди шаблонов функций в словаре. Embedded Coder® обеспечивает встроенные шаблоны, перечисленные в этой таблице.
| Шаблон | Описание |
|---|---|
ModelFunction | В редакторе Отображений Кода используйте для функций точки входа для инициализации, выполнения, завершения, и сбросьте (см., Конфигурируют Генерацию кода По умолчанию для Функций), |
UtilityFunction | В редакторе Отображений Кода используйте для разделяемых служебных функций (см., Конфигурируют Генерацию кода По умолчанию для Функций), |
Description — Цель и функциональность шаблона функцииПользовательский текст, который можно использовать, чтобы описать цель и функциональность шаблона функции.
FunctionName — Имена сгенерированных функций$R$N (значение по умолчанию) | вектор символов | строковый скалярИмена функций в сгенерированном коде в виде правила именования. Правило именования включает комбинацию текста и лексем. Допустимые лексемы перечислены в этой таблице.
| Лексема | Описание |
|---|---|
$R | Имя корневой модели |
$N | Базовое имя присоединенной функции, такой как step |
$U | Пользовательский текст лексемы, который вы задаете для модели как описано в Управлении форматом Идентификатора |
$C | Для разделяемых служебных функций, контрольная сумма, вставленная, чтобы избежать столкновений имени |
$M | Искажающий имя вставленный текст, при необходимости, чтобы избежать столкновений имени |
MemorySection — Местоположение в памяти, чтобы выделить функциюNone (значение по умолчанию) | coder.dictionary.Entry объектМестоположение в памяти, чтобы выделить функцию в виде coder.dictionary.Entry объект, который представляет раздел memory, который существует в Словаре Embedded Coder. Для получения информации о разделах памяти смотрите Данные об Управлении и Функциональное Размещение в Памяти Вставкой Прагм.
Name — Имя раздела memoryИмя раздела memory. Имя должно быть уникальным среди разделов memory в словаре. Embedded Coder обеспечивает встроенные разделы памяти, перечисленные в этой таблице.
| Раздел Memory | Описание |
|---|---|
MemConst | Примените спецификатор типа хранения const к данным. |
MemVolatile | Примените спецификатор типа хранения volatile к данным. |
MemConstVolatile | Примените спецификаторы типа хранения const и volatile к данным. |
Description — Цель и функциональность раздела memoryПользовательский текст, который можно использовать, чтобы описать цель и функциональность раздела memory.
Comment — Прокомментируйте, чтобы вставить в сгенерированный кодКомментарий к коду, который генератор кода включает с прагмами или другими художественными оформлениями, которые вы задаете с PreStatement и PostStatement.
PreStatement — Код, чтобы вставить перед данными или функциональным кодомКод, такой как прагмы, чтобы вставить перед определениями и объявлениями данных или функций, которые находятся в разделе memory.
Можно использовать маркерный $R представлять имя модели, которая использует раздел memory.
Когда вы устанавливаете StatementsSurround к EachVariable, можно использовать маркерный $N представлять имя каждой переменной или функции, которая использует раздел memory.
PostStatement — Код, чтобы вставить после данных или функционального кодаКод, такой как прагмы, чтобы вставить после определений и объявлений данных или функций, которые находятся в разделе memory.
Можно использовать маркерный $R представлять имя модели, которая использует раздел memory.
Когда вы устанавливаете StatementsSurround к EachVariable, можно использовать маркерный $N представлять имя каждой переменной или функции, которая использует раздел memory.
StatementsSurround — Спецификация, чтобы перенести данные и функционирует отдельно или в группеEachVariable (значение по умолчанию) | AllVariablesСпецификация, чтобы вставить операторы кода (PreStatement и PostStatement):
Вокруг каждой переменной и функции, которая использует раздел memory. Выберите EachVariable.
Однажды, вокруг целого раздела memory. Сгенерированный код агрегировал переменные и функциональные определения в непрерывный блок кода и окружает блок операторами. Выберите AllVariables.
get | Получите значение свойства определения кода |
set | Установите значение свойства определения кода |
getAvailableProperties | Возвратите свойства для определения кода |
deleteEntry | Удалите Словарную статью Embedded Coder |
valid | Определите если coder.dictionary.Entry объект представляет допустимое определение кода |
Откройте модель rtwdemo_roll и представляйте Словарь Embedded Coder при помощи coder.Dictionary объект coderDictionary. Используйте этот объект получить доступ к разделу Storage Classes словаря, который содержит определения класса памяти.
rtwdemo_roll
coderDictionary = coder.dictionary.open('rtwdemo_roll');Создайте coder.dictionary.Section объект, который представляет раздел Storage Classes Словаря Embedded Coder.
storageClassesSect = getSection(coderDictionary, 'StorageClasses');Добавьте определение под названием MyStorageClass к разделу Storage Classes. Определение класса памяти использует настройки свойства по умолчанию. Можно изменить эти настройки при помощи set функция.
newEntry = addEntry(storageClassesSect,'MyStorageClass')newEntry =
Entry with properties:
Name: 'MyStorageClass'
DataSource: 'rtwdemo_roll'
coder.Dictionary | coder.dictionary.Section | Словарь Embedded Coder
1. Если смысл перевода понятен, то лучше оставьте как есть и не придирайтесь к словам, синонимам и тому подобному. О вкусах не спорим.
2. Не дополняйте перевод комментариями “от себя”. В исправлении не должно появляться дополнительных смыслов и комментариев, отсутствующих в оригинале. Такие правки не получится интегрировать в алгоритме автоматического перевода.
3. Сохраняйте структуру оригинального текста - например, не разбивайте одно предложение на два.
4. Не имеет смысла однотипное исправление перевода какого-то термина во всех предложениях. Исправляйте только в одном месте. Когда Вашу правку одобрят, это исправление будет алгоритмически распространено и на другие части документации.
5. По иным вопросам, например если надо исправить заблокированное для перевода слово, обратитесь к редакторам через форму технической поддержки.