Настройка отчета описания разработки системы: первая часть

Этот пример показывает вам, как использовать Simulink® Report Generator™, чтобы настроить отчет Описания Разработки системы для модели. Версия по умолчанию отчета предоставляет информацию о разработке системы, представленной моделью Simulink. Можно адаптировать отчет удовлетворить потребности.

Этот пример показывает вам, как настроить отчет под названием Описание Разработки системы. Продукт Simulink Report Generator автоматически создает версию по умолчанию этого отчета из модели Simulink, что вы выбираете. Однако можно сгенерировать настроенную версию этого отчета - например, чтобы придерживаться стандартов документации организации. Эта демонстрация показывает вам, как настроить отчет путем добавления краткого обзора, который следует за титульным листом.

Можно настроить Описание Разработки системы для модели Simulink в качестве примера, sldemo_autotrans, который представляет автомобильную ходовую часть. Чтобы открыть модель в качестве примера, запустите следующую команду:

open_system('sldemo_autotrans')

Откройте диалоговое окно описания разработки системы

В меню File модели Simulink выберите Reports> System Design Description.

Диалоговое окно System Design Description открывается.

Откройте шаблон в Report Explorer

В диалоговом окне System Design Description нажмите кнопку Customize.

Simulink Report Generator создает копию шаблона отчета Описания Разработки системы, SDD_custom.rpt, настроить. Шаблоны задают, как программное обеспечение Simulink Report Generator представляет отчеты из модели. Вы создаете, просматриваете и изменяете шаблоны отчета в названном Report Explorer графического интерфейса пользователя.

Отредактируйте шаблон отчета

При генерации версии по умолчанию отчета Описания Разработки системы вы задаете несколько опций отчета с помощью диалогового окна System Design Description. При настройке отчета необходимо задать эти опции независимо от диалогового окна. Можно установить настроенные опции или графически, с помощью Report Explorer, или программно, с помощью команд MATLAB. Этот пример демонстрирует графический подход.

В левой панели Report Explorer выберите SDD_custom.rpt узел. Правая панель отображает опции отчета для шаблона. Задайте значение для следующих опций отчета.

Директория: C:\MATLAB
FileName : sldemo_autotrans_SDD
FileFormat : Сеть (HTML)
Если отчет уже существует, шаг, чтобы предотвратить перезапись: На

Вы также видите другие опции от диалогового окна System Design Description, сопоставленного с Title Page компонент.

Отредактируйте компонент титульного листа

Сообщите, что шаблоны содержат набор компонентов, которые задают структуру и содержимое отчета. Левая панель Report Explorer перечисляет иерархию компонентов, которые включают SDD_custom.rpt шаблон. Каждый компонент предлагает несколько свойств, значения которых вы задаете, чтобы управлять конкретным аспектом процесса генерации отчета. Правая панель Report Explorer отображает свойства для компонента, который вы выбираете в панели иерархии.

SDD_custom.rpt шаблон включает Title Page компонент, который предоставляет несколько возможностей, сопоставленных с диалоговым окном System Design Description. В Report Explorer, от панели иерархии, выбирают Title Page компонент и задает значение для следующих свойств.

Основной> Заголовок: sldemo_autotrans
Основной> Подзаголовок: Спроектируйте Описание
Основной> Пользовательский автор: Zaphod Beeblebrox
Изображение> Имя файла: C:\images\corporate_logo.gif
Официальное уведомление> текст Официального уведомления: Для Внутреннего Распределения Только

Добавьте Краткий обзор через Компонент Титульного листа

Можно также добавить краткий обзор в отчет с помощью Title Page компонент. В Report Explorer, от панели иерархии, выбирают Title Page компонент; в панели свойств выберите вкладку Abstract и в Абстрактном Текстовом поле, введите:

   Simulink(R) is used to model an automotive drivetrain. Stateflow(R) enhances
   the Simulink model with its representation of the transmission control
   logic. Simulink provides a powerful environment for the modeling and
   simulation of dynamic systems and processes. In many systems, though,
   supervisory functions like changing modes or invoking new gain schedules
   must respond to events that may occur and conditions that develop over time.
   As a result, the environment requires a language capable of managing these
   multiple modes and developing conditions. Stateflow demonstrates its
   strength in this capacity by performing the function of gear selection in
   an automatic transmission.

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

На панели инструментов Report Explorer нажмите кнопку Report. Когда отчет завершен, приложение, сопоставленное с заданным форматом отчета, отображает индивидуально настраиваемое Описание Разработки системы.

Сохраните шаблон

В меню Report Explorer File выберите Save As. Задайте местоположение и имя файла для вашего шаблона пользовательского отчета. Путем сохранения пользовательского шаблона можно получить доступ и снова использовать его. Например, можно применить пользовательский шаблон к другим моделям Simulink, чтобы создать отчеты, которые имеют ту же структуру и формат.

Дополнительная информация

Для получения дополнительной информации о Report Explorer, обратитесь к тому, Каков Report Explorer? в документации Simulink Report Generator. Узнать больше о свойствах Title Page компонент, смотрите его страницу с описанием в документации MATLAB Report Generator.

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