uisimprogress

Display simulation progress bar in app

Since R2024a

Syntax

pgrs = uisimprogress

pgrs = uisimprogress(parent)

pgrs = uisimprogress(___,Name,Value)

Description

pgrs = uisimprogress creates a simulation progress UI component in a new figure.

pgrs = uisimprogress(parent) creates a simulation progress UI component in the specified parent container. The parent can be a figure created using the uifigure function or one of its child containers.

pgrs = uisimprogress(___,Name,Value) specifies SimulationProgress properties using one or more name-value arguments. Use this option with any of the input argument combinations in the previous syntaxes.

Examples

Create Simulation Progress UI Component in Panel

Create a simulation progress UI component in a panel.

fig = uifigure('Name','myFigure');
panel = uipanel(fig)
progressBar = uisimprogress(panel)

Create Simulation Progress Bar to Monitor Simulation

Create a simulation progress UI component in a UI figure, and then specify a Simulation object for simulation progress bar.

Create a UI figure window containing a button and a panel.

fig = uifigure('Name','myFigure');
panel = uipanel(fig)
progressBar = uisimprogress(panel)

Specify a Simulation object to use the simulation progress bar with a model.

runSim = simulation('mdlName')
progressBar.Simulation = runsSim;

Input Arguments

parent — Parent container

Figure object (default) | Tab object | Panel object | GridLayout object | ...

Parent container, specified as a Figure object created using the uifigure function or one of its child containers, such as a Tab, Panel, or GridLayout object. If you do not specify a parent container, MATLAB^® calls the uifigure function to create a new Figure object that serves as the parent container.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: uisimprogress(Color="green")

Note

The properties listed here are a subset of the available properties. For the full list, see SimulationProgress Properties.

Color — Color of simulation progress bar

[0 1 0] (default) | RGB triplet | hexadecimal color code | 'r' | 'g' | 'b' | ...

Color of the simulation progress bar, specified as an RGB triplet, a hexadecimal color code, or one of the color options listed in the table.

RGB triplets and hexadecimal color codes are useful for specifying custom colors.

• An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1]; for example, [0.4 0.6 0.7].

• A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Thus, the color codes "#FF8800", "#ff8800", "#F80", and "#f80" are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Color Name	Short Name	RGB Triplet	Hexadecimal Color Code	Appearance
"red"	"r"	[1 0 0]	"#FF0000"
"green"	"g"	[0 1 0]	"#00FF00"
"blue"	"b"	[0 0 1]	"#0000FF"
"cyan"	"c"	[0 1 1]	"#00FFFF"
"magenta"	"m"	[1 0 1]	"#FF00FF"
"yellow"	"y"	[1 1 0]	"#FFFF00"
"black"	"k"	[0 0 0]	"#000000"
"white"	"w"	[1 1 1]	"#FFFFFF"

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

RGB Triplet	Hexadecimal Color Code	Appearance
[0 0.4470 0.7410]	"#0072BD"
[0.8500 0.3250 0.0980]	"#D95319"
[0.9290 0.6940 0.1250]	"#EDB120"
[0.4940 0.1840 0.5560]	"#7E2F8E"
[0.4660 0.6740 0.1880]	"#77AC30"
[0.3010 0.7450 0.9330]	"#4DBEEE"
[0.6350 0.0780 0.1840]	"#A2142F"

Data Types: double | char

ShowSimTime — Option to display simulation time

on (default) | off

Option to display simulation time, specified as 'on' or 'off' .

ShowElapsedTime — Option to display elapsed time

on (default) | off

Option to display the elapsed simulation time, specified as 'on' or 'off'.

Simulation — Simulation representation

empty (default) | simulink.Simulation object

Simulation representation that provides an interface to control the simulation of a Simulink^® model, specified as a Simulation object.

Version History

Introduced in R2024a