simulateSystem

Class: DataTypeWorkflow.Converter
Package: DataTypeWorkflow

Simulate converter’s system

Syntax

simOut = converter.simulateSystem()
simOut = converter.simulateSystem(Name,Value)
simOut = converter.simulateSystem(simIn)
simOut = converter.simulateSystem(ParameterStruct)
simOut = converter.simulateSystem(ConfigSet)

Description

simOut = converter.simulateSystem() simulates the converter’s selected system.

simOut = converter.simulateSystem(Name,Value) uses additional options specified by one or more Name,Value pair arguments. This method accepts the same Name,Value pairs as the sim function.

simOut = converter.simulateSystem(simIn) simulates the converter’s selected system using the inputs specified in the Simulink.SimulationInput object simIn.

simOut = converter.simulateSystem(ParameterStruct) simulates the converter’s selected system using the parameter values specified in the structure, ParameterStruct.

simOut = converter.simulateSystem(ConfigSet) simulates the converter’s selected system using the configuration settings specified in the model configuration set, ConfigSet.

Note

  • The SimulationMode property must be set to normal. The Fixed-Point Designer™ software does collect simulation ranges in Rapid accelerator or Hot restart modes.

  • The SrcWorkspace parameter must be set to either base or current.

Input Arguments

expand all

Simulation input for the system, specified as a Simulink.SimulationInput object or an array of Simulink.SimulationInput objects.

When you use a SimulationInput object, you can also specify the following Name, Value pair arguments.

ParameterValues
ShowSimulationManager

  • 'on' - Opens the Simulation Manager.

  • 'off' (default) - Does not open the Simulation Manager.

ShowProgress

  • 'on' - View the progress of the simulations in the command window.

  • 'off' (default) - The progress of the simulation does not display in the command window.

Structure with fields that are the names of the configuration parameters for the simulation. The corresponding values are the parameter values.

Data Types: struct

Configuration set, specified as a Simulink.ConfigSet, containing the values of the model parameters.

Output Arguments

expand all

Simulink.SimulationOutput object containing the simulation outputs: logged time, states, and signals.

Tips

  • To correspond your simulation to a specific run name, before simulation, change the CurrentRunName property of the DataTypeWorkflow.Converter object.

  • DataTypeWorkflow.Converter.simulateSystem provides functionality similar to the sim command, except that simulateSystem preserves the model-wide data type override and instrumentation settings of each run.