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 のファイル名を指定します。

入力引数

すべて折りたたむ

`reqSetList` — 要件セット
文字ベクトル (既定値) | `slreq.ReqSet` オブジェクト | 配列

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

`reportOpts` — [レポート] 生成オプション
構造体

MATLAB^® 構造体として指定されたレポート生成オプション。reportOpts が指定されていない場合、slreq.getReportOptionsで指定された既定のオプションを使用してレポートが生成されます。

オプション

フィールド	データ型	説明
`reportPath`	文字ベクトル	生成されたレポートパス。
`titleText`	文字ベクトル	レポートタイトル。
`authors`	文字ベクトル	レポート作成者。
`includes.toc`	Boolean	レポートに目次を含めるオプション。
`includes.links`	Boolean	レポートに要件リンクを含めるオプション。
`includes.rationale`	Boolean	レポートに要件根拠を含めるオプション。
`includes.customAttributes`	Boolean	レポートに要件セットのカスタム属性を含めるオプション。
`includes.comments`	Boolean	レポートに要件コメントを含めるオプション。
`includes.implementationStatus`	Boolean	レポートに要件実装の状態データを含めるオプション。
`includes.verificationStatus`	Boolean	レポートに要件検証の状態データを含めるオプション。
`includes.keywords`	Boolean	レポートに要件実装の状態データを含めるオプション。
`includes.emptySections`	Boolean	レポートに空のセクションを含めるオプション。
`includes.revision`	Boolean	レポートに要件のリビジョン情報を含めるオプション。