Simulink.SimulationOutput

この例のモデルでは、いくつかの異なるログ記録方法を使用してデータをログに記録します。

モデルは時間データを記録するようにも設定されます。

モデルを開きます。

mdl = "LoggingBlocks_NotSSO";
open_system(mdl)

sim(mdl)

recordout

recordout = 
Simulink.SimulationData.Dataset 'Run 1: LoggingBlocks_NotSSO' with 3 elements

                         Name         PropagatedName  BlockPath                   
                         ___________  ______________  ___________________________ 
    1  [1x1 Signal]      Big Sine     Big Sine        LoggingBlocks_NotSSO/Record
    2  [1x1 Signal]      Chirp        Chirp           LoggingBlocks_NotSSO/Record
    3  [1x1 Signal]      Square Wave  Square Wave     LoggingBlocks_NotSSO/Record

  - Use braces { } to access, modify, or add elements using index.

set_param(mdl,"ReturnWorkspaceOutputs","on")

clear

mdl = "LoggingBlocks_NotSSO";
out = sim(mdl);

out

out = 
  Simulink.SimulationOutput:
              ScopeData: [1x1 Simulink.SimulationData.Dataset] 
                logsout: [1x1 Simulink.SimulationData.Dataset] 
              recordout: [1x1 Simulink.SimulationData.Dataset] 
                 simout: [1x1 timeseries] 
                   tout: [51x1 double] 
                   yout: [1x1 Simulink.SimulationData.Dataset] 

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

out.recordout

ans = 
Simulink.SimulationData.Dataset 'Run 2: LoggingBlocks_NotSSO' with 3 elements

                         Name         PropagatedName  BlockPath                   
                         ___________  ______________  ___________________________ 
    1  [1x1 Signal]      Big Sine     Big Sine        LoggingBlocks_NotSSO/Record
    2  [1x1 Signal]      Chirp        Chirp           LoggingBlocks_NotSSO/Record
    3  [1x1 Signal]      Square Wave  Square Wave     LoggingBlocks_NotSSO/Record

  - Use braces { } to access, modify, or add elements using index.

out.recordout{1}

ans = 
  Simulink.SimulationData.Signal
  Package: Simulink.SimulationData

  Properties:
              Name: 'Big Sine'
    PropagatedName: 'Big Sine'
         BlockPath: [1x1 Simulink.SimulationData.BlockPath]
          PortType: 'outport'
         PortIndex: 1
            Values: [1x1 timeseries]

out.recordout{1}.Values

  timeseries

  Common Properties:
            Name: 'Big Sine'
            Time: [51x1 double]
        TimeInfo: tsdata.timemetadata
            Data: [51x1 double]
        DataInfo: tsdata.datametadata

out.recordout{1}.Values.Data

ans = 51×1

         0
    0.3973
    0.7788
    1.1293
    1.4347
    1.6829
    1.8641
    1.9709
    1.9991
    1.9477
      ⋮

シミュレーション結果を単一の出力オブジェクトとして返すようにしてモデルをシミュレートすると、すべてのログ データおよびシミュレーション メタデータに Simulink.SimulationOutput オブジェクトを使用してアクセスできます。

この例のモデルでは [単一のシミュレーション出力] パラメーターが有効になっており、いくつかの異なるログ記録方法を使用してデータをログに記録します。

モデルは時間データを記録するようにも設定されます。

モデルを開きます。

mdl = "LoggingBlocks";
open_system(mdl)

Simulink.SimulationInput オブジェクトを作成してシミュレーションをモデル用に構成します。関数 setModelParameter を使用して StopTime パラメーターを 20 に設定します。

simIn = Simulink.SimulationInput(mdl);
simIn = setModelParameter(simIn,'StopTime','20');

モデルをシミュレートします。関数 sim の出力 out は、シミュレーションからログに記録されるすべてのデータが含まれる Simulink.SimulationOutput オブジェクトです。ブロックごと、ログのタイプごとのデータは、ブロックまたはモデルで指定されているログ変数の名前と一致するプロパティとして保存されます。

out = sim(simIn);

ログ データには、ドット表記、関数 get、または関数 find を使用してアクセスできます。

ドット表記を使用して、To Workspace ブロックを使用してログ記録された Big Sine 信号にアクセスします。

simout = out.simout

  timeseries

  Common Properties:
            Name: 'Big Sine'
            Time: [51x1 double]
        TimeInfo: tsdata.timemetadata
            Data: [51x1 double]
        DataInfo: tsdata.datametadata

関数 get を使用して、信号ログを使用してログ記録された Sine 信号にアクセスします。

logsout = get(out,"logsout")

logsout = 
Simulink.SimulationData.Dataset 'logsout' with 1 element

                         Name  BlockPath               
                         ____  _______________________ 
    1  [1x1 Signal]      Sine  LoggingBlocks/Sine Wave

  - Use braces { } to access, modify, or add elements using index.

関数 find を使用して、出力ログを使用してログ記録された Square Wave 信号にアクセスします。

yout = find(out,"yout")

yout = 
Simulink.SimulationData.Dataset 'yout' with 1 element

                         Name         BlockPath             
                         ___________  _____________________ 
    1  [1x1 Signal]      Square Wave  LoggingBlocks/Outport

  - Use braces { } to access, modify, or add elements using index.

シミュレーション メタデータには、ドット表記または関数 getSimulationMetadata を使用してアクセスできます。

simMetadata = getSimulationMetadata(out)

simMetadata = 
  SimulationMetadata with properties:

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

シミュレーション メタデータは Simulink.SimulationMetadata オブジェクトとして返されます。SimulationMetadata オブジェクトは、シミュレーションに関する情報を構造体値をもつプロパティにグループ化し、シミュレーションに関連する string および追加データを指定できるプロパティをもちます。

SimulationMetadata オブジェクト上の ExecutionInfo プロパティにアクセスします。実行情報には、シミュレーションが停止時間 20 まで警告やエラーなしで実行されたことが示されます。

simMetadata.ExecutionInfo

ans = struct with fields:
               StopEvent: 'ReachedStopTime'
         StopEventSource: []
    StopEventDescription: 'Reached stop time of 20'
         ErrorDiagnostic: []
      WarningDiagnostics: [0x1 struct]

Simulink.SimulationOutput オブジェクトはシミュレーションの結果を表します。SimulationOutput オブジェクトには、シミュレーション メタデータとシミュレーションでログに記録されたすべてのデータが含まれます。Simulink.SimulationOutput オブジェクトの内容は、データ ログやカスタムのプロパティを追加または削除することによって変更できます。

モデル LoggingBlocks を開きます。このモデルは複数のログ手法を使用していくつかの入力信号をログ記録します。

モデルは時間データを記録するようにも設定されます。

mdl = "LoggingBlocks"

mdl = 
"LoggingBlocks"

open_system(mdl);

関数 get_param を使用して、Sine Wave ブロックの [振幅] パラメーターと [周波数] パラメーターの値を保存します。構造体 sinConfig に値を保存します。

sinConfig.sinAmp = get_param(strcat(mdl,"/Sine Wave"),"Amplitude");
sinConfig.sinFreq = get_param(strcat(mdl,"/Sine Wave"),"Frequency");

モデルをシミュレートします。

simOut = sim(mdl);

シミュレーション結果には、シミュレーションで作成されたすべてのログ変数が含まれます。関数 who を使用して、変更可能なプロパティのリストを取得します。

props = who(simOut)

props = 5x1 cell
    {'logsout'  }
    {'recordout'}
    {'simout'   }
    {'tout'     }
    {'yout'     }

このシミュレーションでは、Sine Wave ブロックに関連する信号パスのデータのみを保存すると仮定します。関数 removeProperty を使用して、recordout プロパティと yout プロパティを削除します。

simOut = removeProperty(simOut,["recordout" "yout"]);
who(simOut)

This Simulink.SimulationOutput object contains these editable properties:

    logsout    simout    tout    

独自のプロパティをオブジェクトに追加するか、関数 setUserData を使用して Simulink.SimulationMetadata オブジェクト上の UserData プロパティの値を指定することによって、Simulink.SimulationOutput にデータを追加することもできます。

Sine Wave ブロックのパラメーター値を、Simulink.SimulationOutput オブジェクト上のプロパティとして保存すると仮定します。構造体へのフィールドの追加と同じ方法でドット表記を使用することにより、プロパティ SineWaveParameters を追加します。

simOut.SineWaveParameters = sinConfig;
who(simOut)

This Simulink.SimulationOutput object contains these editable properties:

    SineWaveParameters    logsout    simout    tout    

関数 sldiagviewer.reportSimulationMetadataDiagnostics を使用すると、Simulink.SimulationOutput オブジェクトで取得されたエラーと警告のメッセージを診断ビューアーを使用して表示できます。

モデル ex_sldemo_bounce を開きます。

model = "ex_sldemo_bounce";
open_system(model)

Initial Velocity ブロックの "Value" パラメーターの値を未定義の変数 z として指定して、モデルでエラーを発生させます。

set_param("ex_sldemo_bounce/Initial Velocity","Value","z");

Simulink.SimulationInput オブジェクトを作成してシミュレーションを構成します。

simIn = Simulink.SimulationInput(model);

モデルをシミュレートします。StopOnError オプションを off として指定すると、シミュレーション中に発生したエラーと警告が SimulationOutput オブジェクトで取得されます。コマンド ウィンドウやスクリプトでは報告されず、スクリプトの処理が中断されません。

simOut = sim(simIn,"StopOnError","off","ShowProgress","off");

関数 sldiagviewer.reportSimulationMetadataDiagnostics を使用して、シミュレーションからの警告とエラーのメッセージを診断ビューアーに表示します。

sldiagviewer.reportSimulationMetadataDiagnostics(simOut)