Simulink.SimulationOutput

シミュレーション結果へのアクセス

説明

Simulink.SimulationOutput オブジェクトには、すべてのログ記録されたシミュレーションデータと、シミュレーション条件を説明する SimulationMetadata オブジェクトが含まれます。Simulink.SimulationOutput オブジェクトには、シミュレーションに関する有用なメタデータであるシミュレーション実行時間も含まれます。Simulink.SimulationOutput オブジェクトを使用してシミュレーションの結果を検査できます。また、Simulink.SimulationOutput オブジェクトで関数 plot を使用して結果を可視化できます。Simulink の [実行] ボタンまたは [ステップを進める] ボタンを使用して呼び出したシミュレーションの場合、Simulink.SimulationOutput オブジェクトは、モデルパラメーターで指定された名前でベースワークスペースに格納されます。Simulink.SimulationOutput は書き込み可能です。

作成

既定では、実行するシミュレーションごとに、シミュレーションでログ記録されたすべてのデータを含む Simulink.SimulationOutput オブジェクトと、シミュレーションメタデータを含む Simulink.SimulationMetadata オブジェクトが作成されます。SimulationOutput オブジェクトには複数の方法でアクセスできます。

Simulink.SimulationOutput オブジェクトは、シミュレーションのログデータを返します。
who メソッド、get メソッド、および find メソッドを使用して、出力変数名とそれぞれの値にアクセスできます。

[コンフィギュレーションパラメーター] のモデル設定 [単一のシミュレーション出力] で、シミュレーション出力が Simulink.SimulationOutput オブジェクトで返されるかどうか、またはデータがベースワークスペースで展開されるかどうかを制御します。sim コマンドで名前と値の引数のペアとして ReturnWorkspaceOutputs を on に設定して、この動作にコマンドライン API を使用することもできます。

プロパティ

すべて展開する

`SimulationMetadata` — シミュレーションのメタデータ
`Simulink.SimulationMetadata` オブジェクト

シミュレーションのメタデータ。Simulink.SimulationMetadata オブジェクトとして返されます。UserData フィールドと UserString フィールド以外のフィールドは読み取り専用です。

`ErrorMessage` — シミュレーションログのエラーメッセージ
文字ベクトル

このプロパティは読み取り専用です。

文字ベクトルとして返されるシミュレーションログのエラーメッセージ。シミュレーションがエラーなしで実行される場合、ErrorMessage プロパティは空です。

オブジェクト関数

find	シミュレーション結果の値へのアクセスと表示
get	シミュレーション結果の値へのアクセスと表示
getSimulationMetadata	シミュレーション用の `SimulationMetadata` オブジェクトを返す
setUserData	`SimulationOutput` オブジェクトに含まれる `SimulationMetadata` オブジェクトへのカスタムデータの保存
setUserString	カスタム文字ベクトルを `SimulationOutput` オブジェクト内の `SimulationMetadata` オブジェクトに保存する
who	シミュレーションの出力変数名へのアクセスと表示
plot	シミュレーションデータインスペクターでのシミュレーション出力データのプロット

例

すべて折りたたむ

シミュレーション出力とメタデータの表示

モデルのシミュレーションを実行して、Simulink.SimulationOutput オブジェクトの結果を simOut に配置し、シミュレーションメタデータを表示します。

vdp モデルのシミュレーションを実行します。

simOut = sim('vdp','SaveState','on','StateSaveName','xoutNew',...
                     'SaveOutput','on','OutputSaveName','youtNew')

 Simulink.SimulationOutput:

                xoutNew: [65x2 double] 
                youtNew: [65x2 double] 

     SimulationMetadata: [1x1 Simulink.SimulationMetadata] 
           ErrorMessage: [0x0 char]

変数 youtNew の値を取得します。

simOut.youtNew

Simulink^® から値が返されて表示されます。

シミュレーションのタイミング情報を取得します。

myMetadata = simOut.SimulationMetadata

myMetadata = 

  SimulationMetadata with properties:

        ModelInfo: [1×1 struct]
       TimingInfo: [1×1 struct]
    ExecutionInfo: [1×1 struct]
       UserString: ''
         UserData: []

myMetadata.TimingInfo

ans = 

  struct with fields:

          WallClockTimestampStart: '2016-12-30 08:47:51.739935'
           WallClockTimestampStop: '2016-12-30 08:47:58.185579'
    InitializationElapsedWallTime: 5.9166
         ExecutionElapsedWallTime: 0.1910
       TerminationElapsedWallTime: 0.3380
             TotalElapsedWallTime: 6.4456