Сгенерированный код документа с Simulink Report Generator

Программное обеспечение Simulink® Report Generator™ создает документацию из вашей модели в нескольких форматах, включая HTML, PDF, RTF, Microsoft Word и XML. Этот пример показывает один способ зарегистрировать проект генерации кода в Microsoft® Word. Сгенерированный отчет включает в себя:

  • Системные снимки состояния (модель и схемы подсистемы)

  • Блокируйте список порядков выполнения

  • Simulink Coder™ и информация о версии модели для сгенерированного кода

  • Список сгенерированных файлов

  • Настройки параметра конфигурации оптимизации

  • Системный выбор конечного файла и настройки параметра конфигурации процесса сборки

  • Карта подсистемы

  • Имя файла, путь и списки сгенерированных кодов для исходного кода

Чтобы настроить настройки Simulink Report Generator, чтобы включать пользовательский код и затем сгенерировать отчет для модели, выполните следующие задачи:

Лицензия Simulink Report Generator требуется для следующих форматов отчета: PDF, RTF, Microsoft Word и XML. Для получения дополнительной информации о генерации отчетов в этих форматах см. документацию Simulink Report Generator.

Сгенерируйте код для модели

Прежде чем вы будете использовать Генератор отчетов, чтобы зарегистрировать ваш проект, сгенерируйте код для модели.

  1. В Браузере текущей папки MATLAB® перейдите к папке, где у вас есть доступ для записи.

  2. Создайте рабочую папку из командной строки MATLAB путем ввода:

    mkdir report_ex
  3. Сделайте report_ex вашей рабочей папкой:

    cd report_ex
  4. Откройте модель slexAircraftExample путем ввода имени модели на командной строке MATLAB.

  5. В окне модели выберите File> Save As, перейдите к рабочей папке, report_ex, и сохраните копию модели slexAircraftExample как myModel.

  6. Откройте диалоговое окно Configuration Parameters путем выбора Model Configuration Parameters из меню Simulation.

  7. Выберите панель Solver. В разделе Solver selection задайте параметр Type как Fixed-step.

  8. Выберите панель Code Generation. Select Generate code only.

  9. Нажмите Apply.

  10. В окне модели нажмите Ctrl+B. Процесс сборки генерирует код для модели.

Откройте генератор отчетов

После того, как вы генерируете код, открываете Генератор отчетов.

  1. В окне диаграммы модели выберите Tools> Report Generator.

  2. В окне Report Explorer, в панели опций (центр), кликают по папке rtw (\toolbox\rtw). Кликните по файлу настройки, который это содержит, codegen.rpt.

  3. Дважды кликните codegen.rpt или выберите его и нажмите кнопку Open report. Report Explorer отображает структуру файла настройки в панели схемы (слева).

Определите имя отчета, местоположение и формат

Прежде, чем сгенерировать отчет, можно задать, сообщают выходные опции, такие как папка, имя файла и формат. Например, чтобы сгенерировать Microsoft Word сообщают о названном MyCGModelReport.rtf:

  1. В панели свойств, под Report Options, рассматривают перечисленные опции.

  2. Оставьте набор поля Directory Present working directory.

  3. Для Filename выберите Custom: и замените index на имя MyModelCGReport.

  4. Для File format задайте Rich Text Format и замените Standard Print на Numbered Chapters & Sections.

Включайте модели и подсистемы в отчете

Задайте модели и подсистемы, которые вы хотите включать в сгенерированный отчет путем установки опций в Образцовом компоненте Цикла.

  1. В панели схемы (слева), выберите Model Loop. Генератор отчетов отображает Образцовые опции компонента Цикла в панели свойств.

  2. Если не уже выбранный, выберите Current block diagram для опции Model name.

  3. В панели схемы нажмите Report - codegen.rpt*.

Настройте отчет

После определения моделей и подсистем, чтобы включать в отчет, можно настроить разделы, включенные в отчет.

  1. В панели схемы (слева), расширьте узел Chapter - Generated Code. По умолчанию отчет включает в себя два раздела, каждый содержащий один из двух компонентов отчета.

  2. Расширьте узел Section 1 — Code Generation Summary.

  3. Выберите Code Generation Summary. Опции для компонента отображены в панели свойств.

  4. Нажмите Help, чтобы рассмотреть настройки отчетов, которые можно сделать с компонентом Сводных данных Генерации кода. В данном примере не настраивайте компонент.

  5. В окне Report Explorer расширьте узел Section 1 — Generated Code Listing.

  6. Выберите Import Generated Code. Опции для компонента отображены в панели свойств.

  7. Нажмите Help, чтобы рассмотреть настройки отчетов, которые можно сделать с компонентом Сгенерированного кода Импорта.

Сгенерируйте отчет

После того, как вы настраиваете опции отчета, из окна Report Explorer, генерируете отчет путем нажатия на File> Report. Диалоговое окно Message List открывается, который отображает сообщения, что можно контролировать, когда отчет сгенерирован. Образцовые снимки состояния также появляются во время генерации отчета. Диалоговое окно Message List может быть скрыто позади других диалоговых окон.

Когда отчет будет завершен, откройте отчет, MyModelCGReport.rtf в папке report_ex (в этом примере).