Символы и правила шаблона

Введение

Группы символов шаблонов и символы шаблонов описывают символы шаблонов пользовательской обработки файлов (CFP) и правила их использования. Расположение символа в одном из поставляемых файлов шаблонов (code_c_template.cgt, code_h_template.cgt, data_c_template.cgt, или data_h_template.cgt) определяет, где находятся элементы, связанные с этим символом, в соответствующем сгенерированном файле. Группа символов шаблона определяет группы символов, начиная с родительской («базовой») группы, за которой следуют нижестоящие элементы каждого родительского элемента. Символы шаблонов перечислены в алфавитном порядке.

Примечание

При использовании пользовательских разделов CGT для файлов, созданных для _sharedutils имена символов можно использовать только в группе «Базовый символ».

Группы символов шаблонов

Группа символов	Имена символов в этой группе
База (родители)	`Declarations` `Defines` `Definitions` `Documentation` `Enums` `Functions` `Includes` `Types`
Декларации	`ExternalCalibrationLookup1D` `ExternalCalibrationLookup2D` `ExternalCalibrationScalar` `ExternalVariableScalar`
Определяет	`LocalDefines` `LocalMacros`
Определения	`FilescopeCalibrationLookup1D` `FilescopeCalibrationLookup2D` `FilescopeCalibrationScalar` `FilescopeVariableScalar` `GlobalCalibrationLookup1D` `GlobalCalibrationLookup2D` `GlobalCalibrationScalar` `GlobalVariableScalar`
Документация	`Abstract` `Banner` `Created` `Creator` `Date` `Description` `FileName` `History` `LastModifiedDate` `LastModifiedBy` `ModelName` `ModelVersion` `ModifiedBy`
	`Notes` `ToolVersion`
Функции	`CFunctionCode`
Типы	У этого родителя нет детей.

Символы шаблона

Имя символа *	Группа символов	Область действия символа	Описание символа (что символ помещает в созданный файл)
`Abstract`	Документация	Н/Д	Пользовательское описание модели или файла. Помещается в созданный файл на основе заметки Stateflow ®, аннотации ^Simulink ® или DocBlock в модели. * *
`Banner`	Документация	Н/Д	Комментарии, расположенные в верхней части файла. Содержит информацию, включающую версии модели и программного обеспечения, а также информацию о том, был ли создан файл даты.
`CFunctionCode`	Функции	Файл	Функции C/C + +. Должно находиться в нижней части шаблона.
`Created`	Документация	Н/Д	Дата создания модели. Из поля Создано в диалоговом окне Свойства модели (Model Properties).
`Creator`	Документация	Н/Д	Пользователь, создавший модель. Из поля Создано (Created by) в диалоговом окне Свойства модели (Model Properties).
`Date`	Документация	Н/Д	Файл даты был создан. Взят из компьютерных часов.
`Declarations`	Основа		Объявление данных сигнала или параметра. Например, `extern real_T globalvar;`.
`Defines`	Основа	Файл	Необходимый `#defines` из `.h` файлы.
`Definitions`	Основа	Файл	Определения данных сигналов или параметров.
`Description`	Документация	Н/Д	Описание модели. Из поля Описание модели (Model description) в диалоговом окне Свойства модели (Model Properties). * *
`Documentation`	Основа	Н/Д	Комментарии о том, как интерпретировать созданные файлы.
`Enums`	Основа	Файл	Определения перечисляемых типов данных.
`ExternalCalibrationLookup1D`	Декларации	Внешний	***
`ExternalCalibrationLookup2D`	Декларации	Внешний	***
`ExternalCalibrationScalar`	Декларации	Внешний	***
`ExternalVariableScalar`	Декларации	Внешний	***
`FileName`	Документация	Н/Д	Имя созданного файла.
`FilescopeCalibrationLookup1D`	Определения	Файл	***
`FilescopeCalibrationLookup2D`	Определения	Файл	***
`FilescopeCalibrationScalar`	Определения	Файл	***
`FilescopeVariableScalar`	Определения	Файл	***
`Functions`	Основа	Файл	Сгенерированный код функции.
`GlobalCalibrationLookup1D`	Определения	Глобальный	***
`GlobalCalibrationLookup2D`	Определения	Глобальный	***
`GlobalCalibrationScalar`	Определения	Глобальный	***
`GlobalVariableScalar`	Определения	Глобальный	***
`History`	Документация	Н/Д	Предоставленная пользователем история изменений созданных файлов. Помещается в созданный файл на основе заметки Stateflow, аннотации Simulink или DocBlock в модели. * *
`Includes`	Основа	Файл	`#include` директивы препроцессора.
`LastModifiedDate`	Документация	Н/Д	Дата последнего сохранения модели. Из последнего сохраненного поля в диалоговом окне Свойства модели (Model Properties).
`LastModifiedBy`	Документация	Н/Д	Пользователь, последний сохранивший модель. Из последнего сохраненного поля в диалоговом окне Свойства модели (Model Properties).
`LocalDefines`	Определяет	Файл	`#define` директивы препроцессора из объектов данных генерации кода.
`LocalMacros`	Определяет	Файл	Макросы C/C + +, локальные по отношению к файлу.
`ModelName`	Документация	Н/Д	Имя модели.
`ModelVersion`	Документация	Н/Д	Число, увеличивающееся на 1 при каждом сохранении модели.
`ModifiedBy`	Документация	Н/Д	Имя пользователя, который последним изменил модель.
`Notes`	Документация	Н/Д	Пользовательские прочие примечания о модели или созданных файлах. Помещается в созданный файл на основе заметки Stateflow, аннотации Simulink или DocBlock в модели. * *
`ToolVersion`	Документация	Н/Д	Список версий панелей инструментов, используемых при создании кода.
`Types`	Основа		Типы данных сгенерированного кода.

* Имена символов должны быть заключены между %< >. Например, %<Functions>.

* * Этот символ можно использовать для добавления комментария к созданным файлам. См. раздел Добавление глобальных комментариев в созданный код. Генератор кода помещает комментарий в каждый созданный файл, шаблон которого имеет это имя символа. Генератор кода помещает комментарий в расположение, соответствующее расположению имени символа в файле шаблона.

* * * Описание может быть выведено из имени символа. Например ,GlobalCalibrationScalar - символ, идентифицирующий скаляр. Он содержит данные глобальной области, которые можно откалибровать.

Правила изменения или создания шаблона

Ниже приведены правила создания шаблона MPF. Сравнение шаблона и его созданного файла иллюстрирует несколько из этих правил.

Размещение обозначения на шаблоне в пределах %< > разделитель. Например, символ с именем Includes должен выглядеть следующим образом на шаблоне: %<Includes>. Обратите внимание, что имена символов чувствительны к регистру.
При необходимости разместите обозначение на шаблоне. Его расположение в шаблоне определяет, где находится элемент, связанный с этим символом, в созданном файле. Если с ним не связан ни один элемент, символ игнорируется.
Размещение оператора C/C + + вне %< > разделитель и в строке, отличной от %< > для отображения этой инструкции в созданном файле. Например, #pragma message ("my text") в шаблоне приводит к #pragma message ("my text") в соответствующем местоположении в созданном файле. Обратите внимание, что инструкция должна быть совместима с компилятором C/C + +.
Используйте .cgt расширение для каждого имени файла шаблона. ("cgt"обозначает шаблон создания кода.)
Обратите внимание, что %% $Revision: 1.1.4.10.4.1 $ отображается в верхней части поставляемых шаблонов MathWorks. Это только для внутреннего использования MathWorks. Его не нужно размещать в пользовательском шаблоне и не отображать в созданном файле.
Поместить комментарий к шаблону между /* */ как в стандартном ANSI ® ^{C [}1]. Это приводит к /*comment*/ в созданном файле.
Каждый шаблон MPF должен иметь все символы базовой группы в заданном порядке. Они перечислены в разделе «Группы символов шаблонов». Каждый символ в группе Base является родительским. Например, Declarations является родительским символом.
Каждый символ в группе, отличной от Base, является дочерним. Например, LocalMacros является ребенком.
За исключением нижестоящих элементов «Документация», нижестоящие элементы должны размещаться после родителя, перед следующим родителем и перед Functions символ.
Дочерние элементы документации могут располагаться до или после родителей в любом порядке в любом месте шаблона.
Если в шаблоне отсутствует дочерний элемент, не относящийся к Documentation, генератор кода помещает информацию, связанную с этим дочерним элементом, в родительское расположение в созданном файле.
Если в шаблоне отсутствует дочерний элемент «Документация», генератор кода пропускает информацию, связанную с этим дочерним элементом, из созданного файла.

^[1] ANSI является зарегистрированным товарным знаком Американского национального института стандартов, Inc.

Документация