このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

slreq.generateReport

要件セットのレポートの生成

ページ内をすべて折りたたむ

構文

myReportPath = slreq.generateReport(reqSetList, reportOpts)

説明

myReportPath = slreq.generateReport(reqSetList, reportOpts) は、reportOpts で指定されたオプションを使用して reqSetList で指定された要件セットのレポートを生成し、レポートへのパス myReportPath を返します。

例

例

すべて折りたたむ

% Generate a requirement report in Microsoft(R) Word
% format for all loaded requirement 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 requirement sets
myReport = slreq.generateReport('all', myReportOpts);

メモ

レポートを PDF および HTML 形式で生成するには、reportPath の値として .pdf または .html のファイル名を指定します。

入力引数

すべて折りたたむ

レポート生成の要件セット。1 つの要件セットまたは要件セットの配列を指定できます。読み込まれたすべての要件セットのレポートを生成するには、reqSetList 値として 'all' を指定します。reqSetList の値を指定しない場合、'all' が既定値として使用されます。

レポート生成オプション。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レポートに空のセクションを含めるオプション。この設定に関係なく、要件の [要件タイプ]、[カスタム ID]、[概要]、[説明] の各プロパティについては、レポートに空の値が含まれます。
includes.revisionBooleanレポートに要件のリビジョン情報を含めるオプション。

出力引数

すべて折りたたむ

生成されるレポートのファイル パス。文字ベクトルとして指定します。

バージョン履歴

R2018a で導入

参考

トピック