Main Content

Simulink.sdi.getRunIDByIndex

Use Simulation Data Inspector run index to get run ID

Description

example

runID = Simulink.sdi.getRunIDByIndex(index) returns the run ID for the run with the specified index in the Simulation Data Inspector repository.

Examples

collapse all

Many tasks performed using the Simulation Data Inspector programmatic interface start with obtaining the run ID for a simulation run. This example illustrates several methods to get the run ID for a run. You can use the run ID to access the Simulink.sdi.Run object that contains the run data and metadata and perform run comparisons using the Simulink.sdi.compareRuns function.

Create a Run

The model sldemo_fuelsys is already configured for logging. When you simulate the model, the Simulation Data Inspector automatically creates a run and assigns it a run ID.

load_system('sldemo_fuelsys')
sim('sldemo_fuelsys')

Get Run ID Using Simulink.sdi.getAllRunIDs

The Simulink.sdi.getAllRunIDs function returns an array of all run IDs for the runs in the Simulation Data Inspector repository, in order, with the most recently created run at the end.

runIDs = Simulink.sdi.getAllRunIDs;
runID = runIDs(end);

Get Run ID Using Simulink.sdi.getRunIDByIndex

You can also use the Simulink.sdi.getRunCount and Simulink.sdi.getRunIDByIndex functions to get the run ID for a run. This method is useful if you also want to use count as a counting variable to index through the runs in the Simulation Data Inspector repository.

count = Simulink.sdi.getRunCount;
runID = Simulink.sdi.getRunIDByIndex(count);

Get Run ID from a Simulink.sdi.Run Object

You can also get the run ID from the Simulink.sdi.Run object that corresponds to the run. This example uses the Simulink.sdi.getCurrentSimulationRun function to get the Run object that corresponds to the most recent simulation of the sldemo_fuelsys model. You can also use the Simulink.sdi.Run.getLatest function to access the most recently created Run object.

fuelsysRun = Simulink.sdi.getCurrentSimulationRun('sldemo_fuelsys');
runID = fuelsysRun.ID;

Input Arguments

collapse all

Positive, whole number index of the run in the Simulation Data Inspector repository.

Example: 3

Output Arguments

collapse all

Numeric run identification assigned by the Simulation Data Inspector.

Introduced in R2011b