ROSE  0.9.9.168
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.

Definition at line 172 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)
 Report completion with default name. More...
 
 Report (const std::string &name, double completion)
 Full report with name and completion. More...
 

Public Attributes

std::string name
 What is being reported. More...
 
double completion
 Estimated degree of completion. More...
 

Constructor & Destructor Documentation

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

Initial progress report.

Definition at line 177 of file Progress.h.

Rose::Progress::Report::Report ( double  completion)
inlineexplicit

Report completion with default name.

Definition at line 181 of file Progress.h.

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

Full report with name and completion.

Definition at line 185 of file Progress.h.

Member Data Documentation

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

What is being reported.

Defaults to "progress".

Definition at line 173 of file Progress.h.

double Rose::Progress::Report::completion

Estimated degree of completion.

Usually in [0..1] or NAN.

Definition at line 174 of file Progress.h.

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


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