ドキュメンテーション

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

Simulink.sdi.report

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

構文

  • Simulink.sdi.report
  • Simulink.sdi.report(Name,Value)

説明

Simulink.sdi.report は、シミュレーション データ インスペクターの [実行] ペインで現在のビューとデータに関するレポートを作成します。

Simulink.sdi.report(Name,Value) は、1 つ以上の Name,Value のペア引数によって指定された追加オプションを使用します。

すべて折りたたむ

% Configure model "slexAircraftExample" for logging and simulate
simOut = sim('slexAircraftExample','SaveOutput','on', ...
             'SaveFormat','StructureWithTime', ...
             'ReturnWorkspaceOutputs','on');
  
% Create a Data Inspector run
[~,~,signalIDs] = Simulink.sdi.createRun('My Run','base',{'simOut'});
  
% Select signals for plotting
for i = 1:length(signalIDs)
   signal = Simulink.sdi.getSignal(signalIDs(i));
   signal.checked = true;
end
  
% Create default report, which is the Runs pane view
Simulink.sdi.report;
% Configure model "slexAircraftExample" for logging and simulate
set_param('slexAircraftExample/Pilot','WaveForm','square');
simOut = sim('slexAircraftExample','SaveOutput','on', ...
                  'SaveFormat','StructureWithTime', ...
                  'ReturnWorkspaceOutputs','on');

% Create a Simulation Data Inspector run, Simulink.sdi.Run, from 
% simOut in the base workspace
runID1 = Simulink.sdi.createRun('First Run','namevalue',{'simOut'},{simOut});

% Simulate again
set_param('slexAircraftExample/Pilot','WaveForm','sawtooth');
simOut = sim('slexAircraftExample','SaveOutput','on', ...
             'SaveFormat','StructureWithTime', ...
             'ReturnWorkspaceOutputs','on');
      
% Create another Simulation Data Inspector run
runID2 = Simulink.sdi.createRun('Second Run','namevalue',{'simOut'},{simOut});

% Compare two runs
difference = Simulink.sdi.compareRuns(runID1,runID2);

% Specify columns to include in the report
metaDataOfInterest = [Simulink.sdi.SignalMetaData.Result, ...
                    Simulink.sdi.SignalMetaData.BlockPath1, ...
                    Simulink.sdi.SignalMetaData.RelTol];
% Report on the run comparison
Simulink.sdi.report('ReportToCreate','Compare Runs', ...
                    'ColumnsToReport',metaDataOfInterest, ...
                    'SignalsToReport','ReportAllSignals');

関連する例

入力引数

すべて折りたたむ

名前/値のペアの引数

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

例: 'ColumnsToReport','SignalName'

すべて折りたたむ

レポートに含めるシミュレーション データ インスペクターのペインおよびプロット。'ReportToCreate' および次の値のいずれかで構成されるコンマ区切りのペアとして指定します。

  • 'Inspect Signals'[実行] ペインの情報。

  • 'Compare Runs'[比較] ペインの情報。

例: 'ReportToCreate','Inspect Signals'

すべて折りたたむ

生成されたレポートの場所。'ReportOutputFolder' と文字列で構成されるコンマ区切りのペアとして指定します。

すべて折りたたむ

レポート ファイル名。'ReportOutputFile' と文字列で構成されるコンマ区切りのペアとして指定します。

レポートの上書き防止。'PreventOverwritingFile' および true または false のいずれかの論理値で構成されるコンマ区切りのペアとして指定します。レポート ファイルが存在し、値が true の場合は、レポート ジェネレーターによってファイル名がインクリメントされます。false の場合は、レポート ジェネレーターによりレポート ファイルが (存在する場合) 上書きされます。

信号および実行メタデータの列指定子。'ColumnsToReport' および列の列挙型配列で構成されるコンマ区切りのペアとして指定します。

シミュレーション データ インスペクターで使用できるすべての信号メタデータをリストした列挙クラス Simulink.sdi.SignalMetaData から値を指定する配列。たとえば、[実行] および [Synchronization Method] ペインの列をレポートに含めるには、配列 signal_metadata を作成します。

signal_metadata = [Simulink.sdi.SignalMetaData.Run, Simulink.sdi.SignalMetaData.SyncMethod];
配列をコンマ区切りされたペアの値として指定します。
Simulink.sdi.report('ColumnsToReport',signal_metadata);

次の表の列は、[実行] ペインで使用できます。

列の列挙要素説明
BlockPath (既定の設定)ブロック パス
SignalName (既定の設定)信号名
Line (既定の設定)ライン スタイル
AbsTol (既定の設定)絶対許容誤差
RelTol (既定の設定)相対許容誤差
SyncMethod時間ベクトルを配置する方法: [union][intersection][uniform]
DataSourceデータ ソースを指定する文字列 (logsout.Stick.Data)
TimeSeriesRootSimulink.Timeseries オブジェクトの名前を示す文字列 (logsout.Stick.Time)
TimeSource時間データを含んだ配列を示す文字列 (logsout.Stick.Time)
InterpMethodデータを配置する方法: [zoh][linear]
Port信号出力端子のインデックス
Dimensions信号の次元数
Channel行列データのチャネル
Runシミュレーションの実行名
Modelモデル名

次の表の列は [比較] ペインで使用できます。

列の列挙要素説明
Result (既定の設定)[ベースライン] および [比較対象] の実行間の信号の比較結果
AbsTol (既定の設定)絶対許容誤差
RelTol (既定の設定)相対許容誤差
AlignedBy (既定の設定)[ベースライン] および [比較対象] の実行間で信号データを配置するために使用されるメタデータ
LinkToPlot (既定の設定)各比較結果のプロットへのリンク
BlockPath1[ベースライン] 実行からの信号のブロック パス
BlockPath2[比較対象] 実行からの信号のブロック パス
SignalName[ベースライン] 実行からの信号の名前
DataSource1[ベースライン] 実行からのデータの名前
DataSource2[比較対象] 実行からのデータの名前
SyncMethod[ベースライン] 実行に指定された同期方法
InterpMethod[ベースライン] 実行に指定された内挿法
Channel1[ベースライン] 実行に指定されたチャネル
Channel2[比較対象] 実行に指定されたチャネル

ブロック パス名の長さ。'ShortenBlockPath' および true または false のいずれかの論理値で構成されるコンマ区切りのペアとして指定します。値が true で、ブロックのパス名が長すぎる場合は、シミュレーション データ インスペクターによってレポート内の名前が短くされます。値が false である場合、レポートはブロック パス名全体を表示します。

作成後にレポートを起動します。'LaunchReport' および true または false のいずれかの論理値で構成されるコンマ区切りのペアとして指定します。作成した後に値が true である場合は、生成レポートが開きます。

[比較] ペインのレポートでのみ使用できます。比較信号セット。'SignalsToReport' および次の値のいずれかで構成されるコンマ区切りのペアとして指定します。

  • 'ReportOnlyMismatchedSignals'[ベースライン] および [比較対象] の実行を比較した際の、一致しない信号のみを含めます。

  • 'ReportAllSignals'[ベースライン] および [比較対象] の実行を比較した際のすべての信号を含めます。

代替方法

シミュレーション データ インスペクターの [可視化] タブまたは [比較] タブの [レポートの作成] をクリックします。詳細は、「シミュレーション データ インスペクター レポートを作成する」を参照してください。

R2011b で導入

この情報は役に立ちましたか?