Simulink.profiler.Data

Programmatically access Simulink Profiler information

Since R2020a

Description

The Simulink.profiler.Data object provides access to simulation profiling metadata.

Creation

Access the Simulink.profiler.Data object from the SimulationMetadata.TimingInfo field of the Simulink.SimulationOutput object.

Properties

run — Profiling session identifier

character vector | string scalar

This is a read only property.

Identifier of the profiling session, returned as a character vector or string scalar.

Example: 'vdp @ 21-Nov-2019 13;48:00'

Data Types: char | string

UserString — User documentation of profiling session

"" (default) | character vector | string scalar

Use the UserString field to document relevant information about the current profiling session

Example: profilingData.UserString = "Updated gain to reduce chatter.";

Data Types: char | string

rootUINode — Block hierarchy of the model

Simulink.profiler.UINode object

Block hierarchy of the model, returned as a Simulink.profiler.UINode object with the following fields:

Field	Value	Description
totalTime	double	Execution time of the block, as well as its children.
selfTime	double	Execution time of the block, excluding its children
numberOfCalls	double	Number of times the block was executed during the simulation.
children	Simulink.profiler.UINode array	Contents of the current block
path	string scalar	Path of the block relative to the top level of the model. Note The path of the rootUINode field is the name of the model

A Simulink.profiler.UINode object corresponds to a row in the block hierarchy view of the Simulink^® Profiler.

rootExecNode — Execution stack of the model

Simulink.profiler.ExecNode

Execution phases of the model, returned as a Simulink.profiler.ExecNode object with the following fields:

Field	Value	Description
totalTime	double	Execution time of the stack element, as well as its children.
selfTime	double	Execution time of the stack element, excluding its children
numberOfCalls	double	Number of times the stack element was executed during the simulation.
location		Specific phase of the model's execution
children	Simulink.profiler.ExecNode array	Similar tasks corresponding to the execution phase of the parent.
objectPath	string scalar	Path of the model element corresponding to the current element of the execution stack. Note The objectPathfield of the rootExecNode is the name of the model

A Simulink.profiler.ExecNode object corresponds to a row in the execution stack view of the Simulink Profiler.

Version History

Introduced in R2020a