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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/*
//
// Copyright 1997-2009 Torsten Rohlfing
//
// Copyright 2004-2011 SRI International
//
// This file is part of the Computational Morphometry Toolkit.
//
// http://www.nitrc.org/projects/cmtk/
//
// The Computational Morphometry Toolkit is free software: you can
// redistribute it and/or modify it under the terms of the GNU General Public
// License as published by the Free Software Foundation, either version 3 of
// the License, or (at your option) any later version.
//
// The Computational Morphometry Toolkit is distributed in the hope that it
// will be useful, but WITHOUT ANY WARRANTY; without even the implied
// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with the Computational Morphometry Toolkit. If not, see
// <http://www.gnu.org/licenses/>.
//
// $Revision: 5436 $
//
// $LastChangedDate: 2018-12-10 19:01:20 -0800 (Mon, 10 Dec 2018) $
//
// $LastChangedBy: torstenrohlfing $
//
*/
#ifndef __cmtkProgress_h_included_
#define __cmtkProgress_h_included_
#include <cmtkconfig.h>
#include <string>
#include <queue>
namespace
cmtk
{
/** \addtogroup System */
//@{
/** Generic class for progress indication.
*/
class Progress
{
public:
/// Status code returned by SetPercentDone() method.
typedef enum {
/// Everything okay; continue as usual.
OK,
/// User requests interrupt of operation.
INTERRUPT,
/// Interrupt generated by timeout.
TIMEOUT,
/// Something went wrong.
FAILED
} ResultEnum;
/// This class.
typedef Progress Self;
/// Constructor.
Progress()
{
Self::SetProgressInstance( this );
}
/// Virtual (dummy) destructor.
virtual ~Progress() {};
/// Set total number of steps to complete.
static void Begin( const double start, const double end, const double increment, const std::string& taskName = std::string("") );
/// Set number of tasks completed.
static ResultEnum SetProgress( const double progress );
/// Done with progress indicator.
static void Done();
/// Set number of tasks completed.
virtual ResultEnum UpdateProgress() = 0;
/// Set number of tasks completed.
void SetProgressCurrent( const double progress );
/// Set progress handler instance.
static void SetProgressInstance( Self *const progressInstance )
{
Self::ProgressInstance = progressInstance;
}
protected:
/// Check if we're at the top level of the task hierarchy.
bool IsTopLevel() const
{
return m_RangeStack.size() == 1;
}
/// Return the name of the current task (at the lowest level of nested ranges).
const std::string GetCurrentTaskName() const;
/// Compute current completion fraction from range stack.
double GetFractionComplete() const;
/// Set total number of steps to complete.
virtual void BeginVirtual( const double start, const double end, const double increment, const std::string& taskName = std::string("") );
/** Clean up progress output.
* This member function can be overriden by derived classes.
*/
virtual void DoneVirtual();
private:
/// Instance of a derived class that handles GUI interaction etc.
static Self* ProgressInstance;
/// Class to current progress range, which can be nested.
class Range
{
public:
/// Constructor.
Range( const double start, const double end, const double increment, const std::string& taskName = std::string("") )
: m_Start( start ), m_End( end ), m_Increment( increment ), m_TaskName( taskName )
{
this->m_Current = this->m_Start;
}
/// Get complete fraction for this range.
double GetFractionComplete( const double nestedFraction = 0 /*!< For nexted ranges, this is the fraction achieved in he next level down.*/ ) const;
/// Start of this range.
double m_Start;
/// End of this range.
double m_End;
/// Increment between steps.
double m_Increment;
/// Current position in the range.
double m_Current;
/// Name of this task.
const std::string m_TaskName;
};
/// Type for stack of nested progress ranges.
typedef std::deque<Self::Range> RangeStackType;
/// Stack of nested progress ranges.
RangeStackType m_RangeStack;
};
//@}
} // namespace cmtk
#endif // #ifndef __cmtkProgress_h_included_
|
