1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
#ifndef mbl_progress_hierarchy_h_
#define mbl_progress_hierarchy_h_
//:
// \file
// \brief Assumes a hierarchy in the identifiers and reports a single float score.
// \author Ian Scott
// \date 10 Jan 2008
#include <vcl_string.h>
#include <vcl_vector.h>
#include <mbl/mbl_progress.h>
//========================================================================
//: API for reporting a single progress fraction from multiple hierarchical sources.
//
// This progress class assumes that each identifier is arranged in a hierarchy,
// and that calls to set_estimated_iterations and end_progress are correctly nested.
//
// In order to use this abstract you need to derive this class
// and provide a definition of on_changed_progress().
class mbl_progress_hierarchy: public mbl_progress
{
protected:
//: Called when set_estimate_iterations() is called for a given identifier.
// Derived classes may take some action here.
// \param identifier The operation being monitored.
virtual void on_set_estimated_iterations(const vcl_string& identifier,
const int total_iterations);
//: Called when set_progress() is called for a given identifier.
// Derived classes may take some action here.
// \param identifier The operation being monitored.
// \param progress The new progress status.
virtual void on_set_progress(const vcl_string& identifier,
const int progress);
//: Called when end_progress() is called for a given identifier.
// Derived classes may take some action here.
// \param identifier The operation being monitored.
virtual void on_end_progress(const vcl_string& identifier);
//: Called when the progress has started, changed, or finished.
// \param fraction Progress of all identifiers towards the end.
// value is out of 1.0.
virtual void on_changed_progress(double fraction)=0;
mbl_progress_hierarchy() : just_ended_(false) {}
private:
//: The ordered hierarchy of identifiers.
vcl_vector<vcl_string> identifier_stack_;
//: Has an existing identifier just been ended.
bool just_ended_;
};
//========================================================================
#endif // mbl_progress_hierarchy_h_
|
