Simulink.playback.createSignals

The PlaybackRecord model contains an empty Playback block connected to a Record block. Using the set_param function, you can programmatically add new signals to the Playback block by setting the value of the Signals parameter to a Simulink.playback.Signal object that contains information about the signals you want to add to the block. Once you add data, the Playback block loads external data into the model during simulation. The Record block logs output data from the Playback block.

mdl = "PlaybackRecord";
open_system(mdl)

Create two timeseries objects in the workspace. The timeseries object ts1 stores data for a sine wave and has the signal name Sine. The timeseries object ts2 stores data for a cosine wave and has the signal name Cosine.

time = 0:0.1:10;
ts1 = timeseries(sin(time),"Name","Sine");
ts2 = timeseries(cos(time),"Name","Cosine");

Use the Simulink.playback.createSignals function to create a Simulink.playback.Signal object that contains the workspace variables ts1 and ts2.

wkspSigs = Simulink.playback.createSignals("workspace","Variables",["ts1","ts2"]);

To add the workspace data to the Playback block, use the set_param function to apply the Simulink.playback.Signal object to the Signals parameter of the Playback block.

set_param("PlaybackRecord/Playback","Signals",wkspSigs)

In the model, connect the second port of the Playback block to the Record block. The Playback block displays the names of the added signals. To load the workspace data from the Playback block into your model, run the simulation.

To get information about the signals added to the Playback block, use the get_param function. For example, get information about the Simulink.playback.Signal object that contains data for the Sine signal.

sigsInfo = get_param("PlaybackRecord/Playback","Signals");
sineSigInfo = sigsInfo(2)

sineSigInfo = 
  Signal with properties:

       Source: 'workspace'
     IsLinked: 1
         Name: 'ts1'
      RunName: ''
    PortIndex: '2'

The PlaybackRecord model contains an empty Playback block connected to a Record block. Using the set_param function, you can programmatically add new signals to the Playback block by setting the value of the Signals parameter to a Simulink.playback.Signal object that contains information about the signals you want to add to the block. Once you add data, the Playback block loads external data into the model during simulation. The Record block logs output data from the Playback block.

mdl = "PlaybackRecord";
open_system(mdl)

The Microsoft Excel® file TempDataFile contains two sets of indoor and outdoor temperature data. Use the Simulink.playback.createSignals function to create a Simulink.playback.Signal object that contains all of the signals from the TempDataFile file.

tempSigs = Simulink.playback.createSignals("TempDataFile.xlsx");

To add the temperature data to the Playback block, use the set_param function to apply the Simulink.playback.Signal object to the Signals parameter of the Playback block.

set_param("PlaybackRecord/Playback","Signals",tempSigs)

In the model, connect all of the Playback block ports to the Record block. Alternatively, you can add signal lines programmatically.

set_param("PlaybackRecord/Record","NumPorts",4)
add_line(mdl,"Playback/2","Record/2")
add_line(mdl,"Playback/3","Record/3")
add_line(mdl,"Playback/4","Record/4")

The Playback block displays the names of the added signals. To load the temperature data from the Playback block into your model, run the simulation.

You can also use the set_param function to remove all signals from the Playback block.

set_param("PlaybackRecord/Playback","Signals",[])

To add only some signals from a file to the Playback block, you can use the Variables name-value argument to specify which signals to add to the block. For example, you can add only the indoor temperature data.

indoorTempSigs = Simulink.playback.createSignals("TempDataFile.xlsx","Variables",["TempIndoor_run1","TempIndoor_run2"]);
set_param("PlaybackRecord/Playback","Signals",indoorTempSigs)

In the model, the Playback block displays the names of the two indoor temperature signals that were added to the block and two Ground signals. You can remove the unused ports and signal lines programmatically.

delete_line(mdl,"Playback/3","Record/3")
delete_line(mdl,"Playback/4","Record/4")
set_param("PlaybackRecord/Playback","NumPorts",2)
set_param("PlaybackRecord/Record","NumPorts",2)

A Simulink.SimulationInput object allows you to make changes to a model and run simulations with those changes. These changes are temporarily applied to the model.

The model PlaybackRecord contains an empty Playback block connected to a Record block. Using the setBlockParameter object function, you can temporarily add new signals to the Playback block by setting the value of the Signals parameter to a Simulink.playback.Signal object that contains information about the signal you want to add to the block for a particular run. Once you add data, the Playback block loads external data into the model during simulation. The Record block logs output data from the Playback block.

Suppose you want to simulate the model three times with different data added to the Playback block for each run. You can use a SimulationInput object to temporarily add data to the Playback block for each simulation.

Create three timeseries objects in the workspace.

time = 0:0.1:10;
ts1 = timeseries(sin(time),time,"Name","SineWave");
ts2  = timeseries(cos(time),time,"Name","CosineWave");
ts3  = timeseries(rand(1,length(time)),time,"Name","Random");

Use the Simulink.playback.createSignals function to create a Simulink.playback.Signal object for each timeseries object in the workspace.

pbSig_ts1 = Simulink.playback.createSignals("workspace","Variables","ts1");
pbSig_ts2 = Simulink.playback.createSignals("workspace","Variables","ts2");
pbSig_ts3 = Simulink.playback.createSignals("workspace","Variables","ts3");

Create an array of SimulationInput objects to configure three simulations of the PlaybackRecord model.

for i = 1:3
    simIn(i) = Simulink.SimulationInput("PlaybackRecord");
end

To add each signal to the Playback block, use the setBlockParameter function to apply the appropriate Simulink.playback.Signal object to the Signals parameter of the Playback block for each simulation. For example, for the first simulation, specify the value of the Signals parameter to be pbSig_ts1.

simIn(1) = setBlockParameter(simIn(1),"PlaybackRecord/Playback","Signals",pbSig_ts1);
simIn(2) = setBlockParameter(simIn(2),"PlaybackRecord/Playback","Signals",pbSig_ts2);
simIn(3) = setBlockParameter(simIn(3),"PlaybackRecord/Playback","Signals",pbSig_ts3);

Simulate the model three times using the configuration specified by each element in the array of SimulationInput objects.

out = sim(simIn);

[13-Feb-2024 00:52:02] Running simulations...
[13-Feb-2024 00:52:04] Completed 1 of 3 simulation runs
[13-Feb-2024 00:52:04] Completed 2 of 3 simulation runs
[13-Feb-2024 00:52:04] Completed 3 of 3 simulation runs

Because changes made to a model using a Simulink.SimulationInput object are temporary, the Playback block returns to an empty state after running the simulations. To view and inspect the logged data from the three runs, you can use the Simulation Data Inspector.

Simulink.sdi.view