Main Content

sdo.SimulationTest class

Package: sdo

Simulation scenario description


sim_obj = sdo.SimulationTest(modelname)


Create a scenario to simulate a Simulink® model. A simulation scenario specifies input signals, model parameter and initial state values, and signals to log for a model. You can also specify linear systems to compute if you have Simulink Control Design™ toolbox. Use a simulation scenario to simulate a model with alternative inputs and model parameter and initial state values, without modifying the model.


sim_obj = sdo.SimulationTest(modelname) constructs an sdo.SimulationTest object and assigns the specified model name to the ModelName property and default values to the remaining properties.

You can also construct an sdo.SimulationTest object using the createSimulator method of an sdo.Experiment object. The createSimulator method configures the properties of the sdo.SimulationTest object to simulate the model associated with the experiment.

Input Arguments


Simulink model name, specified as a character vector or string. For example, 'sdoHydraulicCylinder'.

The model must be on the MATLAB® path.



Model initial state for simulation.

This property can be any initial state format that sim command supports.


Input signals.

Specify signals to apply to root level input ports when simulating the model. The signal can be any input signal format that the sim command supports.

Default: []


Data logged during simulation.

You must also specify the signals to log in the LoggingInfo property. The logged data is stored in a Simulink.SimulationOutput object and is populated by the sim method.

This property is read-only.

Default: []


Signals to log when simulating a model.

This property is a Simulink.SimulationData.ModelLoggingInfo object. Specify the signals to log in its Signals property.

Default: 1x1 Simulink.SimulationData.ModelLoggingInfo object


Linear system logging settings.

This property is a vector of sdo.SystemLoggingInfo objects.

If you specify the SystemLoggingInfo property, the sim method linearizes the model during simulation.


You can also use linearize (Simulink Control Design) command from Simulink Control Design to compute linear systems. However, to use fast restart, you must use SystemLoggingInfo property and sim instead.

Default: []


Simulink model name associated with the simulation scenario. The model must be on the MATLAB path.


Name of the scenario

Default: ''


Parameter values.

The software changes the model parameters to the specified values before simulating the model and restores them to their original value after the simulation completes.

This property must be a param.Continuous object.

Default: []


fastRestartSimulate Simulink model in fast restart mode using simulation scenario
findFind logged data set
prepareToDeploy Configure simulation scenario for deployment with Simulink Compiler
simSimulate Simulink model using simulation scenario
whoList logged data names

Copy Semantics

Value. To learn how value classes affect copy operations, see Copying Objects.


collapse all

Create a simulation scenario for a model.

Pressures = Simulink.SimulationData.SignalLoggingInfo;
Pressures.BlockPath = 'sdoHydraulicCylinder/Cylinder Assembly';
Pressures.OutputPortIndex = 1;
simulator = sdo.SimulationTest('sdoHydraulicCylinder');

Specify model signals to log.

simulator.LoggingInfo.Signals = [Pressures];

Specify an experiment for a model.

experiment = sdo.Experiment('sdoRCCircuit');

Create a simulation scenario for the experiment.

sim_obj = createSimulator(experiment);