サンプルレポートテンプレートのカスタマイズ

レポートテンプレートでは、解析結果から生成されるレポートの内容と書式設定を定義します。既存のテンプレートが要件に合わない場合は、テンプレートの特定の側面を変更できます。

このトピックでは、Polyspace^® レポートテンプレートに行えるいくつかのカスタマイズを、短い手順と一緒に説明します。詳細なチュートリアルについては、既存の Code Prover レポートテンプレートのカスタマイズを参照してください。

テンプレートをカスタマイズするには以下を行います。

MATLAB^® Report Generator™ を開きます。MATLAB コマンドプロンプトで、次のように入力します。
```
report
```
既存のテンプレートを開きます。
テンプレートは polyspaceroot/toolbox/polyspace/psrptgen/templates にあります。polyspaceroot は Polyspace のインストールフォルダーです。
テンプレートに対してコンポーネントの追加、削除または変更を行います。
Polyspace 固有のコンポーネントの一覧については、レポートの生成を参照してください。

ソースコード内で検出されたすべての再帰関数をレポートする必要があるとします。

CodeMetrics テンプレートから開始します。コードメトリクスの章に、コンポーネントRecursive Functionsを追加します。

変更したテンプレートを使用してレポートを生成すると、再帰関数のリストのテーブルが表示されます。

すべての実行時チェックの概要と、レッドチェックのみに関する詳細をレポートする必要があるとします。

Developer テンプレートから開始します。次のコンポーネントを含む章を除く、すべての章を削除します。

Code Verification Summary
Run-time Checks Summary Ordered by File
Run-time Checks Details Ordered by Color/File.レッドチェックのみが表示されるように、このコンポーネントを変更します。
コンポーネントを選択します。右側のペインのグループ [Categories To Include] で、[Red Checks] 以外のすべてのボックスをクリアします。
付録コンポーネント: Configuration ParametersおよびAcronym Definitions。

変更したテンプレートを使用してレポートを生成すると、チェックの概要、レッドチェックのみの詳細の章、および付録が表示されます。

正当化されていないチェックのみをレポートする必要があるとします。チェックは、次のいずれかのステータスを割り当てると正当化されます。

最初の章の上にコンポーネントReport Customization (Filtering)を追加します。以降の章に正当化されていないチェックのみが表示されるように、このコンポーネントを変更します。

コンポーネントを選択します。右側のペインのグループ [Advanced Filters] で、[Justification Status] から [Un-justified] を選択します。

変更したテンプレートを使用してレポートを生成すると、正当化されていない実行時チェックのみが表示されます。

コードで assert ステートメントを使用して、機能設計テストを実装するとします。たとえば、関数 out の出力が範囲 [MIN,MAX] に含まれるかどうかをテストする場合、コードでは次のステートメントを使用します。

assert(MIN <= out && out <= MAX);

Polyspace ではチェックユーザーアサーションを実行して、assert 条件が失敗するかどうかを判定します。これらのチェックは他の実行時エラーチェックとは異なるため、個別の章でレポートする必要があるとします。

Developer テンプレートから開始します。コンポーネントRun-time Checks Details Ordered by Color/Fileを含む章をコピーします。

2 つの章を区別できるように、2 つの章タイトルの名前をそれぞれ変更します。各章で、コンポーネント [Run-time Checks Details Ordered by Color/File] を次のように変更します。

一方の章で、[ユーザーアサーション] チェックを除外します。コンポーネントを選択します。右側のペインのグループ [Advanced Filters] で、[Check types to include] に以下を入力します。
```
^(?!User assertion).*
```
もう一方の章で、[ユーザーアサーション] チェックを含めます。コンポーネントを選択します。右側のペインのグループ [Advanced Filters] で、[Check types to include] に以下を入力します。
```
User assertion
```
[ユーザーアサーション] チェックはグレーにならないため、グレーチェックのボックスをオフにします。

変更したテンプレートを使用してレポートを生成すると、実行時チェックに関する章のコピーが 2 つ表示されます。1 つ目の章には [ユーザーアサーション] チェック以外のすべてのチェックが含まれ、2 つ目の章には [ユーザーアサーション] チェックのみが含まれます。

参考