Simulink.sdi.isValidRunID

Determine if run ID is valid

Syntax

valid = Simulink.sdi.isValidRunID(runID)

Description

valid = Simulink.sdi.isValidRunID(runID) returns 1 (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 — Unique Simulation Data Inspector run identifier

positive integer

Unique Simulation Data Inspector run identifier, specified as a positive integer. 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

true or 1 | false or 0

Run validity indicator, specified as a numeric or logical 1 (true) or 0 (false). When valid is true, the runID is valid. When valid is false, the runID is invalid.

Version History

Introduced in R2011b