slreq.generateReport

Сгенерируйте отчет для набора требований

свернуть все на странице

Синтаксис

myReportPath = slreq.generateReport(reqSetList, reportOpts)

Описание

myReportPath = slreq.generateReport(reqSetList, reportOpts) генерирует отчет для наборов требований, заданных reqSetList использование опций задано reportOpts и возвращает путь myReportPath к отчету.

Примеры

Сгенерируйте отчет требования

% Generate a requirement report in Microsoft(R) Word
% format for all loaded requirements sets

% Get default report generation options structure
myReportOpts = slreq.getReportOptions(); 

% Specify the generated report path and file name
myReportOpts.reportPath = 'L:\My_Project\Reqs_Report.docx';
  
% Generate the report for all loaded requirements sets
myReport = slreq.generateReport('all', myReportOpts);

Примечание

Чтобы сгенерировать отчеты в PDF и форматах HTML, задайте .pdf или .html имя файла как reportPath значение.

Входные параметры

свернуть все

Требования устанавливают для генерации отчета. Можно задать один набор требований или массив наборов требований. Чтобы сгенерировать отчет для всех загруженных наборов требований, задайте 'all' как reqSetList значение. Если вы не задаете значение для reqSetListвсе используется в качестве значения по умолчанию.

Сообщите об опциях генерации, заданных как структура MATLAB®. Если reportOpts не задан, отчет сгенерирован с помощью опций по умолчанию, заданных в slreq.getReportOptions.

Опции

Поля Тип данныхОписание
reportPathсимвольный векторСгенерированный путь к отчету.
templatePathсимвольный векторСообщите о шаблоне path.
titleTextсимвольный векторСообщите о заголовке.
authorsсимвольный векторСообщите об авторах.
includes.tocБулевская переменнаяОпция, чтобы включать оглавление в ваш отчет.
includes.linksБулевская переменнаяОпция, чтобы включать ссылки требований в ваш отчет.
includes.rationaleБулевская переменнаяОпция, чтобы включать объяснение требований в ваш отчет.
includes.customAttributesБулевская переменнаяОпция, чтобы включать пользовательские атрибуты набора требований в ваш отчет
includes.commentsБулевская переменнаяОпция, чтобы включать комментарии требования в ваш отчет.
includes.implementationStatusБулевская переменнаяОпция, чтобы включать данные о состоянии реализации требования в ваш отчет.
includes.verificationStatusБулевская переменнаяОпция, чтобы включать данные о состоянии верификации требования в ваш отчет.
includes.keywordsБулевская переменнаяОпция, чтобы включать данные о состоянии реализации требования в ваш отчет.
includes.emptySectionsБулевская переменнаяОпция, чтобы включать пустые разделы в ваш отчет.
includes.revisionБулевская переменнаяОпция, чтобы включать информацию о версии требования в ваш отчет.

Выходные аргументы

свернуть все

Путь к файлу для сгенерированного отчета в виде вектора символов.

Смотрите также

Темы

Введенный в R2018a

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