simulink.multisim.Future

R2026b

Track progress and retrieve results of design-study simulations

Since R2024a

Description

Use the Future object to track simulation progress, wait for completion, retrieve outputs, or cancel running simulations.

Creation

To create a simulink.multisim.Future object, call parsim with a simulink.multisim.DesignStudy object as the input argument.

Properties

State — Current state of the future object

Read-only: 'queued' | 'running' | 'finished' | 'failed'

This property is read-only.

Current aggregated state of all simulations associated with this future, represented as one of the following values:

• 'queued' — Simulations are queued but none have started running.

• 'running' — At least one simulation is running.

• 'finished' — All simulations completed successfully.

• 'failed' — One or more simulations encountered an error or were canceled.

Data Types: char

NumSims — Number of simulations

Read-only: double

This property is read-only.

Number of simulations, represented as a double.

Data Types: double

NumWorkers — Number of parallel workers

Read-only: double

This property is read-only.

Number of parallel workers, represented as a double.

Data Types: double

CreateDateTime — Date and time of object creation

Read-only: datetime

This property is read-only.

Date and time of object creation, represented as a datetime object.

Data Types: datetime

StartDateTime — Date and time when first simulation started

Read-only: datetime

This property is read-only.

Date and time when the first simulation started, represented as a datetime object.

Data Types: datetime

FinishDateTime — Date and time when last simulation finished

Read-only: datetime

This property is read-only.

Date and time when the last simulation finished, represented as a datetime object. This property is empty if simulations have not yet completed.

Data Types: datetime

RunningDuration — Total running time of all simulations

Read-only: duration

This property is read-only.

Total running time of all simulations, represented as a duration.

Data Types: duration

Object Functions

Method	Description
cancel	Cancel a pending, queued, or running simulink.multisim.Future object
fetchOutputs	Retrieve all simulation outputs from simulink.multisim.Future
wait	Wait for simulink.multisim.Future object to complete simulations

Examples

Run Design Study and Fetch Outputs

Run a design study using the vdp model and retrieve the simulation results from the simulink.multisim.Future object.

Define a parameter sweep for Mu and create a design study.

mdl = "vdp";
openExample("simulink_general/VanDerPolOscillatorExample",SupportingFile=mdl);
muValues = [0.5:0.25:5];

paramRange = simulink.multisim.Variable("Mu",muValues);
exht = simulink.multisim.Exhaustive(paramRange);
stdy = simulink.multisim.DesignStudy(mdl,exht);

Run the design study using parsim. The parsim function returns a simulink.multisim.Future object.

f = parsim(stdy);
f.State

ans =
    'running'

Fetch all outputs. The fetchOutputs function blocks interaction with the MATLAB command prompt until all simulations finish.

outputs = fetchOutputs(f)

outputs =
  19x1 Simulink.SimulationOutput array

Specify Output Location and Wait for Simulations

Run simulations with a specified output location and use wait to block execution until all simulations complete.

Run simulations with the output location set to the present working folder.

outputDir = fullfile(pwd,"myResults");
mkdir(outputDir);
f = parsim(stdy,OutputLocation=outputDir);

Wait for completion and check the state.

wait(f);
f.State

ans =
    'finished'

Cancel Running Simulations

Cancel a set of running simulations.

Run a large parameter sweep.

f = parsim(stdy);
f.State

ans =
    'running'

Cancel the running simulations.

cancel(f);
f.State

ans =
    'failed'

Version History

Introduced in R2024a