Main Content

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

report

レポート エクスプローラーの設定ファイルからのレポート生成

説明

report() は、レポート エクスプローラーをアクティブ ウィンドウとして開きます。

[rptFile1,...,rptFileN] = report(setup1,...,setupN) は、指定されたレポート設定ファイルからレポートを生成し、生成されたレポート ファイルの絶対パスを返します。関数は、レポート設定ファイルの構成に従ってレポートを生成します。

rptFile = report(simulinkModel) は、指定された Simulink® モデルに関連付けられたレポート設定ファイルからレポートを生成します。

メモ

  • この構文は、Simulink Report Generator™ がインストールされている場合にのみ使用できます。

  • この構文を使用する前に、Simulink モデルを読み込みます。

[___] = report(___,outFormat) は、指定された形式でレポートを生成します。

[___] = report(___,outFormat,formatTemplate) は、指定された outFormat のテンプレートを使用してレポートを生成します。

[___] = report(___,outFormat,formatStyleSheet) は、指定された outFormat のスタイル シートを使用してレポートを生成します。

[___] = report(___,targetFolder) は、生成されたレポート ファイルを指定されたフォルダーに作成します。

[___] = report(___,targetFile) は、生成されるレポート ファイルのターゲット ルート名を指定します。

[___] = report(___,genOpt1,...,genOptN) は、レポートの生成時に 1 つ以上のオプションを使用します。

すべて折りたたむ

変数を使用して、レポート設定ファイルの名前を格納します。

rpt_file_1 = "first_rpt.rpt";
rpt_file_2 = "second_rpt.rpt";
rpt_file_3 = "third_rpt.rpt";

生成されるレポートのフォルダーを定義し、そのパスを変数 generated_reports_folder に格納します。末尾にバックスラッシュ (\) を含めて、関数 report がパスをルート ファイル名ではなくフォルダーとして識別できるようにします。

generated_reports_folder = "generated_reports\"
generated_reports_folder = 
"generated_reports\"

関数 report の出力パス引数を変数 out_path_param に定義します。

out_path_param = "-o"+generated_reports_folder
out_path_param = 
"-ogenerated_reports\"

関数 report を 1 回使用し、3 つの設定ファイルすべてのレポートを生成して表示します。変数 out_path_param を使用して、レポートを生成するフォルダーを指定します。生成されるレポートのタイプを、書式 dom-pdf のテンプレート default-rg-docx-numbered として指定します。

関数は、一時的な DOCX ファイルを生成して開き、その DOCX ファイルを PDF ファイルに変換します。ドキュメントによるフィールド更新の許可についての Microsoft® Word のポップアップ警告が表示された場合は、[はい] をクリックします。

生成されたレポート ファイルのパスを string 配列 report_file_paths に格納し、ファイルの名前を表示します。

[report_file_paths(1),report_file_paths(2),report_file_paths(3)] = ...
              report(rpt_file_1,rpt_file_2,rpt_file_3,...
                    "-fdom-pdf","-sdefault-rg-docx-numbered",out_path_param);
    Beginning report
    Converting report
Document conversion failed. Generating a PDF report from a template supported only on Windows platforms.
Error running report
Generating a PDF report from a template supported only on Windows platforms.
    Beginning report
    Converting report
Document conversion failed. Generating a PDF report from a template supported only on Windows platforms.
Error running report
Generating a PDF report from a template supported only on Windows platforms.
    Beginning report
    Converting report
Document conversion failed. Generating a PDF report from a template supported only on Windows platforms.
Error running report
Generating a PDF report from a template supported only on Windows platforms.
[~,generated_report_names] = fileparts(report_file_paths);
disp(generated_report_names');
    ""
    ""
    ""

この例では、レポート エクスプローラーを使用して Simulink モデルのレポートを作成する方法を示します。この例を実行するには、Simulink Report Generator がインストールされていなければなりません。

モデルを読み込み、どのレポート設定ファイルがモデルに関連付けられているかを確認します。

model_name = "simple_model";
load_system(model_name);
model_report_name = get_param(model_name,"ReportName")
model_report_name = 
'simple_RPT.rpt'

関数 report を使用し、dom-pdf-direct の書式を使用して reportOnSimpleModel という名前のレポートを現在のディレクトリに生成します。-graphical オプションを使用して、レポート エクスプローラーの [メッセージ リスト] ダイアログ ボックスを開きます。

生成されたレポート ファイルのパスを変数 generated_report_path に格納し、ファイル名と拡張子を表示します。

generated_report_path = report(model_name,"-fdom-pdf-direct","-oreportOnSimpleModel","-graphical");
[~,generated_report_name,generated_report_extension] = fileparts(generated_report_path)
generated_report_name = 
"reportOnSimpleModel"
generated_report_extension = 
".pdf"

この例では、同じルート名で複数のレポートを生成するときに上書きを回避する方法を示します。

レポート設定ファイルの構成

変数を使用して、レポート設定ファイルの名前を格納します。

rpt_file_1 = "my_first_rpt.rpt";
rpt_file_2 = "my_second_rpt.rpt";
rpt_file_3 = "my_third_rpt.rpt";

関数 setedit を使用して、レポート エクスプローラーでレポート設定ファイルを開きます。3 つのファイルすべてで [レポートが既に存在する場合、上書きを防ぐためにインクリメントする] チェック ボックスがオンになっていることを確認します。

setedit(rpt_file_1);
setedit(rpt_file_2);
setedit(rpt_file_3);

レポートの生成

生成されるレポートのベース パスを定義します。

base_report_path = fullfile("","generated_reports","myGeneratedReport")
base_report_path = 
"generated_reports/myGeneratedReport"

関数 report の出力パス引数を変数 out_path_param に定義します。関数は、レポートごとに異なる番号を base_report_path に追加し、異なる名前のレポート ファイルを生成します。

out_path_param = "-o"+base_report_path
out_path_param = 
"-ogenerated_reports/myGeneratedReport"

関数 report を使用し、3 つの設定ファイルのレポートを同時に生成して表示します。out_path_param パラメーターを使用して、生成されるレポートのルート名を指定します。生成されるレポートのタイプを、書式 pdf-fop のスタイル シート fo-YesChapterNumbers として指定します。生成されたレポート ファイルのパスを string 配列 report_file_paths に格納し、ファイルの名前を表示します。上書きを防止するためのインクリメント オプションが選択されているため、生成されるレポート ファイルの名前が異なることに注意してください。

[report_file_paths(1),report_file_paths(2),report_file_paths(3)] = ...
      report(rpt_file_1,rpt_file_2,rpt_file_3,...
                "-fpdf-fop","-sfo-YesChapterNumbers",out_path_param);
    Beginning report
    Converting report
    Report complete
    Beginning report
    Converting report
    Report complete
    Beginning report
    Converting report
    Report complete
[~,generated_report_names] = fileparts(report_file_paths);
disp(generated_report_names');
    "myGeneratedReport0"
    "myGeneratedReport1"
    "myGeneratedReport2"

入力引数

すべて折りたたむ

レポートを生成するためのレポート設定ファイルの名前。string スカラーまたは文字ベクトルとして指定します。

レポートの生成元のレポート設定ファイルに関連付けられた Simulink モデルの名前。string スカラーまたは文字ベクトルとして指定します。

モデルに関連付けられているレポート設定ファイルを確認するには、モデルの ReportName プロパティの値を確認します。例:

model_name = "myModel";
load_system(model_name);
model_report_name = get_param(model_name,"ReportName")
ans =
    'modelRptFile.rpt'
レポート設定ファイルをモデルに関連付けるには、ReportName プロパティの値をレポート設定ファイルの名前に設定します。例:
model_name = "myModel";
new_rpt_file_name = "modelRptFile.rpt";
load_system(model_name);
set_param(model_name,"ReportName",new_rpt_file_name);

メモ

レポート設定ファイル名には、.rpt ファイル拡張子が含まれなければなりません。

既定では、すべてのモデルが simulink-default.rpt に関連付けられています。これは、現在の Simulink システムのレポートを生成するレポート設定ファイルです。

出力レポート形式。-fFORMAT の形式で string スカラーまたは文字ベクトルとして指定します。ここで、FORMAT は有効な書式の値です。

DOM 書式のリストを取得するには、次を使用します。

rptconvert("-domformatlist")
レガシ書式 (DOM 以外) のリストを取得するには、次を使用します。
rptconvert("-formatlist")

レポートの生成に使用する outFormat のテンプレート。string スカラーまたは文字ベクトルとして -sTEMPLATE の形式で指定します。ここで、TEMPLATE は書式 outFormat の有効なテンプレートです。レガシ書式にはテンプレートがありません。すべての DOM 書式にはテンプレートがあります。任意の有効な DOM 書式である outFormat 書式の有効なテンプレートのリストを表示するには、次のコマンドを入力します。

rptconvert("-templatelist",outFormat)

レポートの生成に使用する outFormat のスタイル シート。string スカラーまたは文字ベクトルとして -sSTYLE_SHEET の形式で指定します。ここで、STYLE_SHEET は書式 outFormat の有効なスタイル シートです。DOM 書式にはスタイル シートがありません。db を除くすべての非 DOM 書式にはスタイル シートがあります。db を除く任意の有効な非 DOM 書式である outFormat 書式の有効なスタイル シートのリストを表示するには、次のコマンドを入力します。

rptconvert("-stylesheetlist",outFormat)

作成されたレポート ファイルのベース ターゲット ファイル名。-oNAME の形式の string スカラーまたは文字ベクトルとして指定します。ここで、NAME は、作成するファイルのベース名またはパスです。

メモ

targetFile を単一のベース名またはパスとして指定します。関数が同じ名前で複数のレポート ファイルの生成を試みることを防ぐには、複数のレポート設定ファイルでこの構文を使用する場合、レポート エクスプローラーのアウトライン ペインで各レポート設定ファイルを選択し、プロパティ ペインで [レポートが既に存在する場合、上書きを防ぐためにインクリメントする] チェック ボックスがオンになっていることを確認します。その後は、関数が、ベース ファイル名またはパスに異なる番号を追加して、異なる名前で各レポート ファイルを作成するようになります。

Report setup file is selected and the check box is selected

レポート ファイルを作成するターゲット フォルダー。-oPATH の形式で string スカラーまたは文字ベクトルとして指定します。ここで、PATH は相対パスまたは絶対パスです。

メモ

PATH は、スラッシュ (/) またはバックスラッシュ (\) で終わらなければなりません。

レポート生成のオプション。次のように指定します。

説明
"-noview"

生成されたレポートを表示用に開かない

"-graphical"

レポート エクスプローラーにレポート設定ファイルを読み込み、レポートを生成する前に [メッセージ リスト] ダイアログ ボックスを開く。レポートの生成前にレポート エクスプローラーに読み込まれなかった設定ファイルは、レポートの生成後に読み込み解除されます。

"-debug"

MATLAB® コマンド ラインにデバッグ情報を出力する。

"-quiet"

コマンド ライン出力を抑制する。-debug オプションと一緒に使用した場合、このオプションは無視されます。

出力引数

すべて折りたたむ

生成されたレポート ファイルの絶対パス。1 つ以上 (生成されたレポート ファイルごとに 1 つずつ) の string スカラーとして返されます。

バージョン履歴

R2006a より前に導入