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
|
/*
//
// 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 __cmtkProgressConsole_h_included_
#define __cmtkProgressConsole_h_included_
#include <cmtkconfig.h>
#include <System/cmtkProgress.h>
#include <string>
/** \addtogroup System */
//@{
namespace
cmtk
{
/** Progress indicator with console output.
* This class displays the programm progress on the console, using cmtk::StdErr.
* If this process is being run from inside Slicer3, output is based on Slicer's
* XML-type progress reporting instead, and this is written to std::cout.
*
*\see http://www.slicer.org/slicerWiki/index.php/Slicer3:Execution_Model_Documentation#Showing_Progress_in_an_Application
*/
class ProgressConsole :
/// Inherit generic progress indicator interface.
public Progress
{
public:
/// This class.
typedef ProgressConsole Self;
/// Superclass.
typedef Progress Superclass;
/// Default constructor: connect to progress indicator.
ProgressConsole( const std::string& programName = std::string("") );
/// Destructor: finish things up.
virtual ~ProgressConsole();
/// Output progress to console.
virtual ResultEnum UpdateProgress();
protected:
/// Begin a new level of progress reporting.
virtual void BeginVirtual( const double start, const double end, const double increment, const std::string& taskName );
private:
/// Name of this program.
std::string m_ProgramName;
/// Process time at start of task.
double m_TimeAtStart;
/// Flag that indicates whether we're running inside of Slicer3.
bool m_InsideSlicer3;
};
} // namespace cmtk
//@}
#endif // #ifndef __cmtkProgressConsole_h_included_
|
