Description
A single progress report.
Progress is reported and monitored as a stream of progress reports, and this object represents one such report.
A progress report has a name, an amount completed, and a maximum value. The name is optional. The amount completed is normally a non-negative number and can be NAN if the completion amount is unknown. The maximum is the expected upper range of the completion (defaulting to 1.0) and is used to calculate percents. If the maximum is NAN, then the percent completed cannot be computed and perhaps a busy indicator or spinner would be used instead of a progress bar to represent the state.
Definition at line 179 of file Progress.h.
#include <Progress.h>
Public Member Functions | |
| Report () | |
| Initial progress report. | |
| Report (double completion, double maximum=1.0) | |
| Report completion with default name. | |
| Report (const std::string &name, double completion, double maximum=1.0) | |
| Report with name and completion. | |
Public Attributes | |
| std::string | name |
| What is being reported. More... | |
| double | completion |
| Estimated degree of completion. More... | |
| double | maximum |
| Maximum value for completion. More... | |
Member Data Documentation
◆ name
| std::string Rose::Progress::Report::name |
What is being reported.
Defaults to empty string.
Definition at line 180 of file Progress.h.
Referenced by Rose::Progress::reportChanges().
◆ completion
| double Rose::Progress::Report::completion |
Estimated degree of completion.
In [0..maximum] or NAN.
Definition at line 181 of file Progress.h.
Referenced by Rose::ProgressTask::ProgressTask().
◆ maximum
| double Rose::Progress::Report::maximum |
Maximum value for completion.
Defaults to 1.0. NAN => spinner.
Definition at line 182 of file Progress.h.
The documentation for this struct was generated from the following file:
