Simulink.sdi.isValidRunID

Determine whether a run ID is valid

Syntax

valid = Simulink.sdi.isValidRunID(runID)

Description

valid = Simulink.sdi.isValidRunID(runID) returns true if runID corresponds to a run in the Simulation Data Inspector repository.

Examples

Check Run ID Validity

This example shows how to check whether a run ID is valid. You can use Simulink.sdi.isValidRunID to ensure you have valid data throughout your script.

Create a Simulation Run

Simulate the model sldemo_fuelsys to create a run in the Simulation Data Inspector, and use Simulink.sdi.getAllRunIDs to get its run ID.

% Simulate model
load_system('sldemo_fuelsys')
sim('sldemo_fuelsys')

% Get run ID
runIDs = Simulink.sdi.getAllRunIDs;
runID = runIDs(end);

Check Run ID Validity

Check to verify that the Simulation Data Inspector has a run corresponding to the run ID.

Simulink.sdi.isValidRunID(runID)

ans = logical
   1

Delete the Run and Check Validity

You can delete runs to clear out memory space or clean up the Simulation Data Inspector UI. When you delete a run, the run ID for that run becomes invalid.

Simulink.sdi.deleteRun(runID)

Simulink.sdi.isValidRunID(runID)

ans = logical
   0

Input Arguments

runID — Simulation Data Inspector run identifier

scalar

Unique numeric identification for the run. The Simulation Data Inspector assigns run IDs when it creates runs. You can get the run ID for your run using Simulink.sdi.getAllRunIDs or Simulink.sdi.getRunIDByIndex.

Output Arguments

valid — Run validity indicator

logical

Run validity indicator. When valid is true, the runID is valid. When valid is false, the runID is invalid.

Version History

Introduced in R2011b