メインコンテンツ

レポート API によるシステム設計レポートの生成

この例では、レポート API ベースのシステム設計レポートを生成する方法を説明します。システム設計レポートは、システムの Simulink® モデルから生成した動的システムの設計の説明です。

レポート API ベースのシステム設計レポートは、レポート API クラスのオブジェクトを使用して、システム コンポーネントのレポートを生成します。Simulink および Stateflow 要素用の Report Generator の作成を参照してください。

関数 gensdd

この例に含まれる関数 gensdd は、次の各節が含まれるレポートを生成します。

  • タイトル ページ

  • 目次

  • 図のリスト

  • 表のリスト

  • システム階層

  • ルート システムの章。ルート ブロック線図、モデルのメモ (ある場合)、タスクとブロックの実行順序、ルート ブロック線図内にある各ブロックのプロパティが含まれます

  • サブシステムの章。モデルのサブシステムのブロック線図、モデルのメモ (ある場合)、ブロックの実行順序、ブロック プロパティが含まれます

  • チャートの章。チャートと、各モデル チャートのチャート オブジェクトのプロパティが含まれます

  • 設計データの章。モデル変数が含まれます

  • システム モデル コンフィギュレーションの章。モデルのアクティブなコンフィギュレーション セットの詳細が含まれます

関数 gensdd 全体はこの例の最後に記載されています。gensdd.m file を変更して、カスタム システム設計レポートを作成できます。

sf_car モデルの PDF システム設計レポートの生成

sf_car モデルのシステム設計レポートを生成して、ドキュメントを PDF に指定します。

gensdd("sf_car","PDF");

レポートの最初のページは以下のとおりです。

Snippet of report showing the title page that contains the model name, "System Design Description", a snapshot of the model, the author name, and the report creation date.

この例には、ファイル sdd_sf_car_copy.pdf 内のレポートのコピーが含まれています。

レポートのカスタマイズ

関数 gensdd は次のレポート API クラスのオブジェクトを使用して、システム設計要素を検索し、システム設計についてのレポートを生成します。

レポーター クラス

ファインダー クラスと結果クラス

これらのオブジェクトのプロパティを使用して、レポートされる情報へのフィルターの適用と書式設定ができます。たとえば、gensdd.m ファイルの関数 makeSystemHierarchy では、slreportgen.report.SystemHierarchy レポーターの ListFormatter プロパティを設定することにより、システム階層リストの形式を順序付きリストに変更できます。

function makeSystemHierarchy(rpt, hModel)
% Create a chapter reporting on the system hiearchy
import mlreportgen.report.*
import slreportgen.report.*
ch = Chapter("Title", "System Hierarchy");
ol = mlreportgen.dom.OrderedList();
add(ch,SystemHierarchy("Source",hModel,"ListFormatter",ol));
add(rpt, ch);
end

Snippet of the report showing part of Chapter 1 titled "System Hiearchy" and a portion of the linked model hiearchy.

また、レポートは次のレポート API クラスのオブジェクトを使用して、レポートの節の作成と書式設定を行います。

レポートと節の外観をカスタマイズできます。レポートの書式設定方法を参照してください。

関数 gensdd の全体

 type gensdd.m

参考

| | | | | | | | | | | | |

トピック