Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
ProgressLogger.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2013.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Stephan Aiche$
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_CONCEPT_PROGRESSLOGGER_H
36 #define OPENMS_CONCEPT_PROGRESSLOGGER_H
37 
38 #include <OpenMS/CONCEPT/Types.h>
40 
41 class QProgressDialog;
42 
43 namespace OpenMS
44 {
45  class String;
46 
56  class OPENMS_DLLAPI ProgressLogger
57  {
58 public:
61 
63  ~ProgressLogger();
64 
66  enum LogType
67  {
68  CMD,
69  GUI,
70  NONE
71  };
72 
74  void setLogType(LogType type) const;
75 
77  LogType getLogType() const;
78 
90  void startProgress(SignedSize begin, SignedSize end, const String & label) const;
91 
93  void setProgress(SignedSize value) const;
94 
96  void endProgress() const;
97 
98 protected:
99  mutable LogType type_;
101  mutable SignedSize end_;
103  mutable QProgressDialog * dlg_;
105  mutable time_t last_invoke_;
106  static int recursion_depth_;
107  };
108 
109 } // namespace OpenMS
110 
111 #endif //OPENMS_CONCEPT_PROGRESSLOGGER_H
A more convenient string class.
Definition: String.h:56
SignedSize end_
Definition: ProgressLogger.h:101
LogType
Possible log types.
Definition: ProgressLogger.h:66
StopWatch Class.
Definition: StopWatch.h:62
static int recursion_depth_
Definition: ProgressLogger.h:106
ptrdiff_t SignedSize
Signed Size type e.g. used as pointer difference.
Definition: Types.h:151
Progress dialog.
Definition: ProgressLogger.h:69
SignedSize value_
Definition: ProgressLogger.h:102
QProgressDialog * dlg_
Definition: ProgressLogger.h:103
SignedSize begin_
Definition: ProgressLogger.h:100
Command line progress.
Definition: ProgressLogger.h:68
time_t last_invoke_
Definition: ProgressLogger.h:105
Base class for all classes that want to report their progess.
Definition: ProgressLogger.h:56
LogType type_
Definition: ProgressLogger.h:99
StopWatch stop_watch_
Definition: ProgressLogger.h:104

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:19 using doxygen 1.8.5