OpenMS
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-2023.
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: Timo Sachsenberg$
32 // $Authors: Marc Sturm, Stephan Aiche $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/CONCEPT/Types.h>
38 
39 namespace OpenMS
40 {
41  class String;
42 
52  class OPENMS_DLLAPI ProgressLogger
53  {
54 public:
57 
59  virtual ~ProgressLogger();
60 
63 
66 
68  enum LogType
69  {
70  CMD,
71  GUI,
72  NONE
73  };
74 
78  class OPENMS_DLLAPI ProgressLoggerImpl
79  {
80 public:
81  virtual void startProgress(const SignedSize begin, const SignedSize end, const String& label, const int current_recursion_depth) const = 0;
82  virtual void setProgress(const SignedSize value, const int current_recursion_depth) const = 0;
83  virtual SignedSize nextProgress() const = 0; //< does not print/show anything; returns current progress
84  virtual void endProgress(const int current_recursion_depth) const = 0;
85 
86  virtual ~ProgressLoggerImpl() {}
87 
89  static void registerChildren();
90 
91  };
92 
94  void setLogType(LogType type) const;
95 
98 
110  void startProgress(SignedSize begin, SignedSize end, const String& label) const;
111 
113  void setProgress(SignedSize value) const;
114 
116  void endProgress() const;
117 
119  void nextProgress() const;
120 
121 protected:
122  mutable LogType type_;
123  mutable time_t last_invoke_;
124  static int recursion_depth_;
125 
128 
130 
131  };
132 
133 } // namespace OpenMS
134 
This class represents an actual implementation of a logger.
Definition: ProgressLogger.h:79
virtual void setProgress(const SignedSize value, const int current_recursion_depth) const =0
virtual void startProgress(const SignedSize begin, const SignedSize end, const String &label, const int current_recursion_depth) const =0
virtual SignedSize nextProgress() const =0
static void registerChildren()
Factory requirements.
virtual void endProgress(const int current_recursion_depth) const =0
virtual ~ProgressLoggerImpl()
Definition: ProgressLogger.h:86
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:53
void setProgress(SignedSize value) const
Sets the current progress.
ProgressLogger & operator=(const ProgressLogger &other)
Assignment Operator.
ProgressLogger()
Constructor.
void setLogType(LogType type) const
Sets the progress log that should be used. The default type is NONE!
static String logTypeToFactoryName_(LogType type)
Return the name of the factory product used for this log type.
ProgressLogger(const ProgressLogger &other)
Copy constructor.
void startProgress(SignedSize begin, SignedSize end, const String &label) const
Initializes the progress display.
time_t last_invoke_
Definition: ProgressLogger.h:123
LogType type_
Definition: ProgressLogger.h:122
static int recursion_depth_
Definition: ProgressLogger.h:124
void endProgress() const
Ends the progress display.
virtual ~ProgressLogger()
Destructor.
ProgressLoggerImpl * current_logger_
Definition: ProgressLogger.h:129
LogType getLogType() const
Returns the type of progress log being used.
void nextProgress() const
increment progress by 1 (according to range begin-end)
LogType
Possible log types.
Definition: ProgressLogger.h:69
@ CMD
Command line progress.
Definition: ProgressLogger.h:70
@ GUI
Progress dialog.
Definition: ProgressLogger.h:71
A more convenient string class.
Definition: String.h:60
ptrdiff_t SignedSize
Signed Size type e.g. used as pointer difference.
Definition: Types.h:134
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48