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символьный векторСгенерированный путь к отчету.
titleTextсимвольный векторСообщите о заголовке.
authorsсимвольный векторСообщите об авторах.
includes.tocBooleanОпция, чтобы включать оглавление в ваш отчет.
includes.linksBooleanОпция, чтобы включать ссылки требований в ваш отчет.
includes.rationaleBooleanОпция, чтобы включать объяснение требований в ваш отчет.
includes.customAttributesBooleanОпция, чтобы включать пользовательские атрибуты набора требований в ваш отчет
includes.commentsBooleanОпция, чтобы включать комментарии требования в ваш отчет.
includes.implementationStatusBooleanОпция, чтобы включать данные о состоянии реализации требования в ваш отчет.
includes.verificationStatusBooleanОпция, чтобы включать данные о состоянии верификации требования в ваш отчет.
includes.keywordsBooleanОпция, чтобы включать данные о состоянии реализации требования в ваш отчет.
includes.emptySectionsBooleanОпция, чтобы включать пустые разделы в ваш отчет.
includes.revisionBooleanОпция, чтобы включать информацию о версии требования в ваш отчет.

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

свернуть все

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

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

Темы

Введенный в R2018a

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

Поддержка

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