qc_set_simulation_mode qc_update_model navigation bar

Table of Contents

qc_get_simulation_status

Gets the simulation status of the model.

Syntax

status = qc_get_simulation_status(model) % Gets the simulation status of the model
status = qc_get_simulation_status        % Gets the simulation status of the current model
    

Description

Gets the simulation status of a model. The return value will be one of the following strings:

'updating' = the model is updating (see qc_update_model)
'initializing' = the model is initializing
'running' = the model is running in normal simulation
'paused' = the model is paused in normal simulation
'terminating' = the model is terminating
'stopped' = the model is not running, it is stopped
'external' = the model is connected in external mode

If no model is specified then it behaves as if the currently selected model, as returned by

bdroot

MATLAB Command Line

Click to copy the following command line to the clipboard. Then paste it in the MATLAB Command Window:

doc('bdroot')
, was passed as a single input argument.

It is important to note that if the model is not connected in external mode then this function does NOT return the status of code running on the target. To get the status of code on the target, use qc_is_model_loaded instead.

Parameters

model

A string indicating the name of the model for which to get simulation status eg. 'q_a_lpbk'.

Outputs

status

A string indicating the simulation status. See above Description for possible values.

Examples

status = qc_get_simulation_status('q_a_lpbk'); % Get the 'q_a_lpbk' model simulation status
    

See Also

 

navigation bar