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

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

  • Снимки системы (диаграммы модели и подсистемы)

  • Список порядков выполнения блока

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

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

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

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

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

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

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

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

  2. Откройте Генератор отчетов

  3. Задать имя, местоположение и формат отчета

  4. Включение моделей и подсистем в отчет

  5. Настройка отчета

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

Лицензия 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. На вкладке Simulation в списке Save выберите Save as. Перейдите к рабочей папке, report_ex, и сохраните копию slexAircraftExample модель как myModel.

  6. Откройте диалоговое окно Параметры конфигурации. Установите параметр Solver > Solver selection > Type равным Fixed-step.

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

  8. Нажмите Apply.

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

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

После генерации кода откройте Генератор отчетов.

  1. Откройте приложение Report Generator В окне диаграммы модели, в галерее Apps, нажмите 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. Генератор отчетов отображает опции компонента 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 (в этом примере).

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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте