report

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

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

構文

report

[rptFile1,...,rptFileN] = report(setup1,...,setupN)

rptFile = report(simulinkModel)

[___] = report(___,outFormat)

[___] = report(___,outFormat,formatTemplate)

[___] = report(___,outFormat,formatStyleSheet)

[___] = report(___,targetFolder)

[___] = report(___,targetFile)

[___] = report(___,genOpt1,...,genOptN)

説明

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 Simulink Report Generator

ライブスクリプトを開く

この例では、レポートエクスプローラーを使用して 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"

入力引数

すべて折りたたむ

`setup1,...,setupN` — レポート設定ファイルの名前
文字ベクトル | string スカラー

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

`simulinkModel` — レポート設定ファイルに関連付けられた Simulink モデルの名前
文字ベクトル | 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 システムのレポートを生成するレポート設定ファイルです。

`outFormat` — 出力レポート形式
文字ベクトル | string スカラー

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

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

rptconvert("-domformatlist")

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

rptconvert("-formatlist")

`formatTemplate` — 出力書式のテンプレート
文字ベクトル | string スカラー

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

rptconvert("-templatelist",outFormat)

`formatStyleSheet` — 出力書式のスタイルシート
文字ベクトル | string スカラー

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

rptconvert("-stylesheetlist",outFormat)

`targetFile` — 作成されたレポートファイルのベースターゲットファイル名
文字ベクトル | string スカラー

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

メモ

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

Report setup file is selected and the check box is selected

`targetFolder` — レポートファイルを作成するターゲットフォルダー
文字ベクトル | string スカラー

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

メモ

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

`genOpt1,...,genOptN` — レポート生成のオプション
`"-noview"` | `"-graphical"` | `"-debug"` | `"-quiet"`

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

値	説明
`"-noview"`	生成されたレポートを表示用に開かない
`"-graphical"`	レポートエクスプローラーにレポート設定ファイルを読み込み、レポートを生成する前に [メッセージリスト] ダイアログボックスを開く。レポートの生成前にレポートエクスプローラーに読み込まれなかった設定ファイルは、レポートの生成後に読み込み解除されます。
`"-debug"`	MATLAB^® コマンドラインにデバッグ情報を出力する。
`"-quiet"`	コマンドライン出力を抑制する。`-debug` オプションと一緒に使用した場合、このオプションは無視されます。

出力引数

すべて折りたたむ

`rptFile1,...,rptFileN` — 生成されたレポートファイルの絶対パス
string スカラー

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

バージョン履歴

R2006a より前に導入

参考

setedit | rptconvert | rptlist | compwiz

report

構文

説明

例

レポート エクスプローラーを使用した複数のレポートの同時生成

レポート エクスプローラーを使用した Simulink モデルのレポート

複数レポート生成時のファイル上書きの回避

入力引数

setup1,...,setupN — レポート設定ファイルの名前 文字ベクトル | string スカラー

simulinkModel — レポート設定ファイルに関連付けられた Simulink モデルの名前 文字ベクトル | string スカラー

outFormat — 出力レポート形式 文字ベクトル | string スカラー

formatTemplate — 出力書式のテンプレート 文字ベクトル | string スカラー

formatStyleSheet — 出力書式のスタイル シート 文字ベクトル | string スカラー

targetFile — 作成されたレポート ファイルのベース ターゲット ファイル名 文字ベクトル | string スカラー

targetFolder — レポート ファイルを作成するターゲット フォルダー 文字ベクトル | string スカラー

genOpt1,...,genOptN — レポート生成のオプション "-noview" | "-graphical" | "-debug" | "-quiet"

出力引数

rptFile1,...,rptFileN — 生成されたレポート ファイルの絶対パス string スカラー

バージョン履歴

参考

トピック

レポートエクスプローラーを使用した複数のレポートの同時生成

レポートエクスプローラーを使用した Simulink モデルのレポート

`setup1,...,setupN` — レポート設定ファイルの名前
文字ベクトル | string スカラー

`simulinkModel` — レポート設定ファイルに関連付けられた Simulink モデルの名前
文字ベクトル | string スカラー

`outFormat` — 出力レポート形式
文字ベクトル | string スカラー

`formatTemplate` — 出力書式のテンプレート
文字ベクトル | string スカラー

`formatStyleSheet` — 出力書式のスタイルシート
文字ベクトル | string スカラー

`targetFile` — 作成されたレポートファイルのベースターゲットファイル名
文字ベクトル | string スカラー

`targetFolder` — レポートファイルを作成するターゲットフォルダー
文字ベクトル | string スカラー

`genOpt1,...,genOptN` — レポート生成のオプション
`"-noview"` | `"-graphical"` | `"-debug"` | `"-quiet"`

`rptFile1,...,rptFileN` — 生成されたレポートファイルの絶対パス
string スカラー