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, 'all' используется как значение по умолчанию.

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

Опции

ОбластиТип данныхОписание
reportPathвектор символовСгенерированный путь к отчету.
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 документация

Поддержка

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