Настройка моделей для отчета описания разработки системы
Этот пример показывает вам, как использовать Simulink® Report Generator™, чтобы создать отчет Описания Разработки системы для модели. Отчет предоставляет итоговую или подробную информацию о разработке системы, представленной моделью Simulink.
Этот пример показывает вам, как сгенерировать отчет под названием Описание Разработки системы. Продукт Simulink Report Generator автоматически создает отчет из модели Simulink, что вы выбираете. Это заполняет отчет с содержимым из модели Simulink. Можно настроить отчет путем изменения аспектов модели Simulink.
Можно настроить модель Simulink в качестве примера, sldemo_autotrans, который представляет автомобильную ходовую часть. Чтобы открыть модель в качестве примера, запустите следующую команду:
open_system('sldemo_autotrans')
Задайте описания для сущностей модели
По умолчанию отчет Описания Разработки системы включает в себя текст, заданный Description свойство сопоставлено с моделями и блоками. Используйте это свойство добавить пользовательскую документацию в отчет.
Модель Simulink в качестве примера, sldemo_autotrans, уже задает текст в его Description свойство. Чтобы получить доступ к этому свойству, в меню модели File, выбирают Model Properties. В диалоговом окне Model Properties выберите вкладку Description.
Когда вы генерируете Описание Разработки системы для этой модели, отчет получает текст и включает в себя его в главе Корневой системы.
Точно так же можно задать текст для Description свойство сопоставлено с отдельными блоками Subsystem в модели. Например, в sldemo_autotrans, щелкните правой кнопкой по Блоку двигателя и из контекстного меню, выберите Properties. В диалоговом окне Block Properties, для свойства Description, задают следующий текст:
Подсистемы двигателей состоят из двумерной интерполяционной таблицы, которая интерполирует крутящий момент механизма по сравнению с дросселем и скоростью вращения двигателя.
После того, как вы примените изменение и регенерируете Описание Разработки системы для этой модели, отчет получает текст и включает в себя его в главе Подсистем.
Добавьте DocBlocks в иерархию модели
По умолчанию отчет Описания Разработки системы включает в себя текст в DocBlock. Используйте эти блоки в иерархии модели, чтобы добавить пользовательскую документацию в отчет.
Например, в sldemo_autotrans, дважды кликните Подсистемы двигателей, чтобы просмотреть его содержимое. От Браузера Библиотеки Simulink перетащите DocBlock (под библиотекой Model-Wide Utilities) к Подсистемам двигателей.
Дважды кликните DocBlock и в редакторе, задайте следующий текст:
The TorqueConverter and the TransmissionRatio blocks make up the Transmission subsystem. The TorqueConverter is a masked subsystem that requires a vector of speed ratios (Nin/Ne) and vectors of K-factor (f2) and torque ratio (f3). The TransmissionRatio block determines the gear ratio and computes the transmission output torque and input speed.
После того, как вы сохраните текст и регенерируете Описание Разработки системы для этой модели, отчет получает вашу документацию и включает в себя ее в главе Подсистем.
Соедините требования с сущностями модели
По умолчанию отчет Описания Разработки системы перечисляет ссылки требования, которые вы устанавливаете между документами требований и объектами Stateflow или Simulink. Вы создаете ссылки требования с помощью программного обеспечения Simulink Verification and Validation, для которого вам нужна лицензия на продукты.
Например, примите что требования для sldemo_autotrans модель находится в документе Word Microsoft®.
Предположим, что вы соединяете требование Engine в том документе Подсистемам двигателей в sldemo_autotrans модель. Если вы генерируете Описание Разработки системы для этой модели, отчет получает ссылку требования в главе Трассируемости требований. Глава отображает таблицы, которые предоставляют описания требования и гиперссылки на ассоциированные документы, позволяя вам перейти легко к конкретным требованиям.
Дополнительная информация
Для получения дополнительной информации о Description свойство, сопоставленное с моделями, смотрите Диалоговое окно Model Properties в руководстве пользователя Simulink. Чтобы узнать больше о DocBlock, смотрите его страницу с описанием в документации Simulink. Для получения дополнительной информации о соединении требований к компонентам модели, обратитесь к Ссылкам Между Моделями и Требованиями в документации Simulink Verification and Validation.