Main Content

generateReport

メトリクス結果を含むレポート ファイルを生成する

R2021a 以降

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

    構文

    reportFile = generateReport(metricEngine)
    reportFile = generateReport(metricEngine,'App','DashboardApp','Dashboard',dashboardIdentifier)
    reportFile = generateReport(___,Name,Value)

    説明

    reportFile = generateReport(metricEngine) は、メトリクス エンジン metricEngine に対するモデル テスト ダッシュボード内のメトリクス結果について、プロジェクトのルート フォルダーに PDF レポートを作成します。レポートを生成する前に、関数 execute を使用してメトリクス エンジンのメトリクス結果を収集します。

    例

    reportFile = generateReport(metricEngine,'App','DashboardApp','Dashboard',dashboardIdentifier) は、メトリクス エンジン metricEngine に対する dashboardIdentifier ダッシュボード内のメトリクス結果について、プロジェクトのルート フォルダーに PDF レポートを作成します。レポートを生成する前に、関数 execute を使用してエンジンのメトリクス結果を収集します。

    なお、関数 generateReport (Fixed-Point Designer) は Fixed-Point Designer™ ドキュメンテーションにもあります。

    例

    reportFile = generateReport(___,Name,Value) は、1 つ以上の名前と値の引数を使用してオプションを指定します。たとえば、'Type','html-file' は HTML レポートを生成します。

    例

    すべて折りたたむ

    プロジェクト内のテスト アーティファクトを解析し、結果を含むレポート ファイルを生成します。

    解析するプロジェクトを開きます。この例では、MATLAB® コマンド ウィンドウで次のように入力します。

    openExample("slcheck/ExploreTestingMetricDataInModelTestingDashboardExample");
openProject("cc_CruiseControl");

    プロジェクトの metric.Engine オブジェクトを作成します。

    metric_engine = metric.Engine();

    metric_engine のトレース情報を更新して、アーティファクト情報が確実に最新の状態になるようにします。

    updateArtifacts(metric_engine)

    ダッシュボードのバージョンを 'ModelUnitTesting' として指定して、モデル テスト ダッシュボードで使用可能なメトリクス識別子のリストを作成します。

    metric_ids = getAvailableMetricIds(metric_engine,...
'App','DashboardApp',...
'Dashboard','ModelUnitTesting');

    メトリクス識別子のリストに対してメトリクス エンジンを実行して、結果を収集します。

    execute(metric_engine, metric_ids);

    プロジェクトのルート フォルダーに、モデル テスト結果の PDF レポートを生成します。

    generateReport(metric_engine,'App','DashboardApp',...
'Dashboard','ModelUnitTesting');

    レポートが自動的に開きます。レポートが自動的に開かないようにするには、関数 generateReport の呼び出し時に 'LaunchReport' を false として指定します。

    レポート内のユニットごとに、要件、設計、およびテスト内のアーティファクトの数を表示するアーティファクト サマリー テーブルがあります。

    プロジェクト内のアーティファクトの保守性を解析し、結果を含むレポート ファイルを生成します。

    解析するプロジェクトを開きます。この例では、MATLAB コマンド ウィンドウで次のように入力します。

    openExample("slcheck/ExploreTestingMetricDataInModelTestingDashboardExample");
openProject("cc_CruiseControl");

    プロジェクトの metric.Engine オブジェクトを作成します。

    metric_engine = metric.Engine();

    ダッシュボードのバージョンを 'ModelMaintainability' として指定して、モデル保守性ダッシュボードのメトリクス識別子のリストを作成します。

    metric_ids = getAvailableMetricIds(metric_engine,...
'App','DashboardApp',...
'Dashboard','ModelMaintainability');

    メトリクス識別子のリストに対してメトリクス エンジンを実行して、結果を収集します。

    execute(metric_engine, metric_ids);

    プロジェクトのルート フォルダーである現在のディレクトリに、maintainabilityResults という名前の HTML レポートを生成します。

    reportLocation = fullfile(pwd, 'maintainabilityResults.html');
generateReport(metric_engine,'App','DashboardApp',...
'Dashboard','ModelMaintainability',...
'Type','html-file','Location',reportLocation);

    レポートが自動的に開きます。レポートが自動的に開かないようにするには、関数 generateReport の呼び出し時に 'LaunchReport' を false として指定します。

    コンテンツのテーブルを開き、各ユニットの結果に移動するには、レポートの左上隅にあるメニュー アイコン をクリックします。

    入力引数

    すべて折りたたむ

    メトリクス結果を収集したメトリクス エンジン オブジェクト。metric.Engine オブジェクトとして指定します。

    ダッシュボードの識別子。以下のいずれかとして指定します。

    • モデル保守性ダッシュボードの場合は、"ModelMaintainability"

    • PIL コード テスト ダッシュボードの場合は、"ModelUnitPILTesting"

    • SIL コード テスト ダッシュボードの場合は、"ModelUnitSILTesting"

    • モデル テスト ダッシュボードの場合は、"ModelUnitTesting"

    例: "ModelMaintainability"

    データ型: char | string

    名前と値の引数

    引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。Name は引数名、Value は対応する値です。名前と値の引数は他の引数の後に表示されなければなりませんが、ペアの順序は重要ではありません。

    R2021a より前では、名前と値をそれぞれコンマを使って区切り、Name を引用符で囲みます。

    例: 'Type','html-file'

    生成されたレポートを自動的に開くオプション。true または false として指定します。

    例: false

    データ型: logical

    生成されるレポートの完全なファイル名。文字ベクトルまたは string スカラーとして指定します。場所を使用してレポートの名前を指定します。

    既定では、レポート名は dashboardIdentifier の後にアンダースコア、その後にプロジェクト名を付けたものです。レポートは、プロジェクトのルート フォルダーに生成されます。

    例: 'C:\MyProject\Reports\RBTResults.html'

    生成されるレポートのファイル タイプ。'pdf' または 'html-file' として指定します。

    例: 'html-file'

    出力引数

    すべて折りたたむ

    生成されたレポートの完全なファイル名。文字ベクトルとして返されます。

    代替機能

    アプリ

    ダッシュボード ユーザー インターフェイスを使用してレポートを生成できます。

    ダッシュボード ユーザー インターフェイスを開くには、以下のいずれかの方法を使用します。

    • コマンド ウィンドウで次を入力します。

      modelDesignDashboard
      ダッシュボードでモデル保守性ダッシュボードが開きます。

    • コマンド ウィンドウで次を入力します。

      modelTestingDashboard
      ダッシュボードでモデル テスト ダッシュボードが開きます。

    ツールストリップで [レポート] ボタンをクリックします。[メトリクスの結果レポートの作成] ダイアログが開きます。[作成] をクリックしてレポートを作成します。

    ダッシュボード ユーザー インターフェイスを使用する方法の例については、モデル保守性ダッシュボードを使用して設計の複雑度を監視するを参照してください。

    バージョン履歴

    R2021a で導入

    参考

    | | | | | |

    トピック