最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Simulink.sdi.report

シミュレーション データ インスペクター レポートを生成する

説明

Simulink.sdi.report は、プロットされたデータのシミュレーション データ インスペクター レポートをシミュレーション データ インスペクターの [検査] ペインで作成します。

Simulink.sdi.report(Name,Value) は、1 つ以上の Name,Value のペア引数で指定された追加のオプションを使用して、指定されたビューのレポートをシミュレーション データ インスペクターで生成します。

すべて折りたたむ

この例では、シミュレーション データ インスペクターのプログラムによるインターフェイスを使用してレポートを作成する方法を示します。[検査] ペインでプロットされた信号または [比較] ペインの比較データに対するレポートを作成できます。この例では、最初にモデルのシミュレーションを実行してデータを生成した後に、Inspect Signals レポートを作成する方法を示します。この例を説明どおり正確に実行するには、関数Simulink.sdi.clearを使用してシミュレーション データ インスペクターのリポジトリを空にした状態で開始するようにしてください。

データの生成

この例では、2 つの望ましいスリップ比率でモデル ex_sldemo_absbrake を使用してデータを生成します。

% Ensure Simulation Data Inspector is empty
Simulink.sdi.clear

% Open model
load_system('ex_sldemo_absbrake')

% Set slip ratio and simulate model
set_param('ex_sldemo_absbrake/Desired relative slip','Value','0.24')
sim('ex_sldemo_absbrake');

% Set new slip ratio and simulate model again
set_param('ex_sldemo_absbrake/Desired relative slip','Value','0.25')
sim('ex_sldemo_absbrake');

[検査] ペインでの信号のプロット

Inspect Signals レポートには、[検査] ペインのグラフィカルな表示領域でプロットされたすべての信号と、プロットした信号で表示されたすべてのメタデータが含まれます。

% Get Simulink.sdi.Run objects
runIDs = Simulink.sdi.getAllRunIDs;
runID1 = runIDs(end-1);
runID2 = runIDs(end);

run1 = Simulink.sdi.getRun(runID1);
run2 = Simulink.sdi.getRun(runID2);

% Get Simulink.sdi.Signal objects for slp signal
run1_slp = run1.getSignalByIndex(4);
run2_slp = run2.getSignalByIndex(4);

% Plot slp signals
run1_slp.plotOnSubPlot(1, 1, true)
run2_slp.plotOnSubPlot(1, 1, true)

[検査] ペインでプロットされた信号のレポートの作成

シミュレーション データ インスペクターの UI で列を追加してレポートにより多くのデータを含めるか、名前と値のペアおよび列挙型クラス Simulink.sdi.SignalMetaData を使用して、プログラムによりレポートに必要な情報を指定できます。この例では、レポートのデータをプログラムで指定する方法を示します。

% Specify report parameters
reportType = 'Inspect Signals';
reportName = 'Data_Report.html';


signalMetadata = [Simulink.sdi.SignalMetaData.Run, ...
    Simulink.sdi.SignalMetaData.Line, ... 
    Simulink.sdi.SignalMetaData.BlockName, ...
    Simulink.sdi.SignalMetaData.SignalName];

Simulink.sdi.report('ReportToCreate', reportType, 'ReportOutputFile', ...
    reportName, 'ColumnsToReport', signalMetadata);

入力引数

すべて折りたたむ

名前と値のペアの引数

オプションのコンマ区切りされた Name,Value の引数ペアを指定します。ここで、Name は引数名、Value は対応する値です。Name は引用符で囲まなければなりません。Name1,Value1,...,NameN,ValueN のように、複数の名前と値のペア引数を任意の順序で指定できます。

例: 'ReportToCreate','Compare Runs','ShortenBlockPath',true

レポートにキャプチャするシミュレーション データ インスペクターのペイン。

  • 'Inspect Signals' –– [検査] ペインの情報のレポートを作成する。

  • 'Compare Runs' –– [比較] ペインの情報のレポートを作成する。

例: 'ReportToCreate','Inspect Signals'

例: 'ReportToCreate','Compare Runs'

レポートを保存するフォルダー。レポートを保存するフォルダーのパスを文字ベクトルとして指定します。

例: 'ReportOutputFolder','C:\Users\user1\Desktop'

レポートのファイル名。

例: 'ReportOutputFile','MyReport.html'

レポートのファイル上書き保護。ファイル上書き保護は、後続のレポートでインクリメントする数値を含むファイルに名前を付加することで、シミュレーション データ インスペクターによる既存ファイルの上書きを防止します。ファイル上書き保護を無効にすると、一意のファイル名を指定しない限り、シミュレーション データ インスペクターは既存のレポート ファイルを上書きします。

  • true はファイル上書き保護を有効にする。

  • false はファイル上書き保護を無効にする。

例: 'PreventOverwritingFile',true

例: 'PreventOverwritingFile',false

レポートに含める信号メタデータ。既定では、Inspect Signals レポートには、プロットされた各信号に関するブロック パス、名前、ラインのスタイルと色およびデータ ソース パラメーターが含まれます。既定では、Compare Runs レポートには、信号名、絶対許容誤差、相対許容誤差、最大差分のメタデータが含まれます。

列挙型クラス Simulink.sdi.SignalMetaData を使用して、含めるメタデータを配列として指定します。たとえば、シミュレーション実行の名前と信号名を含めるには、signal_metadata のような配列を作成します。

signal_metadata = [Simulink.sdi.SignalMetaData.Run,...
                    Simulink.sdi.SignalMetaData.SignalName];

次に、ColumnsToReport を名前と値のペアで signal_metadata として指定します。

Simulink.sdi.report('ColumnsToReport',signal_metadata)

次の表は、Inspect Signals レポートで利用可能なメタデータをまとめたものです。

列の値説明
SignalName (既定の設定)信号名
Line (既定の設定)信号線のスタイルと色
SID

Simulink® 識別子

SID の詳細については、Simulink 識別子を使用したブロック線図コンポーネントの検索を参照してください。

Units信号の測定単位
SigDataType信号のデータ型
SigSampleTime信号のサンプリングに使用されるメソッド
Model信号を生成したモデルの名前
BlockName信号のソース ブロックの名前
BlockPath 信号のソース ブロックへのパス
Portブロックの出力端子上の信号のインデックス
Dimensions信号が含まれている行列の次元
Channel行列内の信号のインデックス
Run信号が含まれているシミュレーション実行の名前
AbsTol 信号に関する絶対許容誤差
RelTol 信号に関する相対許容誤差
OverrideGlobalTol信号の許容誤差がグローバルな許容誤差よりも優先されるかどうかを指定するプロパティ
TimeTol信号に関する時間の許容誤差
InterpMethod内挿法
SyncMethod比較用に信号を調整するために使用される同期メソッド
TimeSeriesRootMATLAB® ワークスペースからインポートされた信号の信号に関連付けられた変数の名前
TimeSourceMATLAB ワークスペースからインポートされた信号の時間データを含む配列の名前
DataSourceMATLAB ワークスペースからインポートされた信号の信号データを含む配列の名前

次の表は、Compare Runs レポートで利用可能なメタデータをまとめたものです。

列の値説明
Result (既定の設定)[ベースライン] および [比較対象] の実行間の信号の比較結果 (パス/失敗)
Line1[ベースライン] 信号のラインのスタイルと色
Line2[比較対象] 信号のラインのスタイルと色
AbsTol (既定の設定)[ベースライン] 信号に関する絶対許容誤差
RelTol (既定の設定)[ベースライン] 信号に関する相対許容誤差
MaxDifference[ベースライン] 信号と [比較対象] 信号の間の最大差分
OverrideGlobalTol[ベースライン] 信号の許容誤差がグローバルな許容誤差よりも優先されるかどうかを指定するプロパティ
TimeTol[ベースライン] 信号に関する時間の許容誤差
SignalName1[ベースライン] 実行からの信号の名前
SignalName2[比較対象] 実行からの信号の名前
Units1[ベースライン] 実行に含まれる信号の測定単位
Units2[比較対象] 実行に含まれる信号の測定単位
SigDataType1[ベースライン] 実行に含まれる信号のデータ型
SigDataType2[比較対象] 実行に含まれる信号のデータ型
SigSampleTime1[ベースライン] 実行に含まれる信号のサンプリングに使用されるメソッド
SigSampleTime2[比較対象] 実行に含まれる信号のサンプリングに使用されるメソッド
Run1[ベースライン] 実行の名前
Run2[比較対象] 実行の名前
AlignedBy (既定の設定)[ベースライン] 信号と [比較対象] 信号の関連付けに使用される信号の整列メソッド
Model1[ベースライン] 信号を生成したモデルの名前
Model2[比較対象] 信号を生成したモデルの名前
BlockName1[ベースライン] 信号のソース ブロックの名前
BlockName2[比較対象] 信号のソース ブロックの名前
BlockPath1[ベースライン] 信号のソース ブロックへのパス
BlockPath2[比較対象] 信号のソース ブロックへのパス
Port1ブロックの出力端子上にある [ベースライン] 信号のインデックス
Port2ブロックの出力端子上にある [比較対象] 信号のインデックス
Dimensions1[ベースライン] 信号が含まれている行列の次元
Dimensions2[比較対象] 信号が含まれている行列の次元
Channel1行列内の [ベースライン] のインデックス
Channel2行列内の [比較対象] のインデックス
InterpMethod[ベースライン] 信号に関する内挿法
SyncMethod[ベースライン] 信号に関する同期メソッド
TimeSeriesRoot1MATLAB ワークスペースからインポートされた信号の [ベースライン] 信号に関連付けられた変数の名前
TimeSeriesRoot2MATLAB ワークスペースからインポートされた信号の [比較対象] 信号に関連付けられた変数の名前
TimeSource1MATLAB ワークスペースからインポートされた信号の [ベースライン] 時間データを含む配列の名前
TimeSource2MATLAB ワークスペースからインポートされた信号の [比較対象] 時間データを含む配列の名前
DataSource1MATLAB ワークスペースからインポートされた信号の [ベースライン] 信号データを含む配列の名前
DataSource2MATLAB ワークスペースからインポートされた信号の [比較対象] 信号データを含む配列の名前
LinkToPlot (既定の設定)各比較結果のプロットへのリンク

例: 'ColumnsToReport',metadata

ブロック パスの長さ。

  • true –– 短縮したブロック パスの長さをレポート。

  • false –– ブロックの絶対パスをレポートに含める。

例: 'ShortenBlockPath',false

作成時にレポートを開きます。

  • true –– 作成時にレポートを開く。

  • false –– 作成時にレポートを開かない。

例: 'LaunchReport',false

Compare Runs レポートに含める信号。

  • ReportOnlyMismatchedSignals –– 許容誤差から外れている信号のみを含める。

  • ReportAllSignals –– すべての信号を含める。

例: 'SignalsToReport','ReportAllSignals'

R2011b で導入