ROSE  0.9.10.91
Public Member Functions | Public Attributes | List of all members
Rose::Progress::Report Struct Reference

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 178 of file Progress.h.

#include <Progress.h>

Collaboration diagram for Rose::Progress::Report:
Collaboration graph
[legend]

Public Member Functions

 Report ()
 Initial progress report. More...
 
 Report (double completion, double maximum=1.0)
 Report completion with default name. More...
 
 Report (const std::string &name, double completion, double maximum=1.0)
 Report with name and completion. More...
 

Public Attributes

std::string name
 What is being reported. More...
 
double completion
 Estimated degree of completion. More...
 
double maximum
 Maximum value for completion. More...
 

Constructor & Destructor Documentation

Rose::Progress::Report::Report ( )
inline

Initial progress report.

Definition at line 184 of file Progress.h.

Rose::Progress::Report::Report ( double  completion,
double  maximum = 1.0 
)
inlineexplicit

Report completion with default name.

Definition at line 188 of file Progress.h.

Rose::Progress::Report::Report ( const std::string &  name,
double  completion,
double  maximum = 1.0 
)
inline

Report with name and completion.

Definition at line 192 of file Progress.h.

Member Data Documentation

std::string Rose::Progress::Report::name

What is being reported.

Defaults to empty string.

Definition at line 179 of file Progress.h.

double Rose::Progress::Report::completion

Estimated degree of completion.

In [0..maximum] or NAN.

Definition at line 180 of file Progress.h.

Referenced by Rose::ProgressTask::ProgressTask().

double Rose::Progress::Report::maximum

Maximum value for completion.

Defaults to 1.0. NAN => spinner.

Definition at line 181 of file Progress.h.


The documentation for this struct was generated from the following file: