OpenMS  3.0.0
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-2022.
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 
62  ProgressLogger(const ProgressLogger& other);
63 
65  ProgressLogger& operator=(const ProgressLogger& other);
66 
68  enum LogType
69  {
70  CMD,
71  GUI,
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 
97  LogType getLogType() const;
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 
127  static String logTypeToFactoryName_(LogType type);
128 
130 
131  };
132 
133 } // namespace OpenMS
134 
Types.h
OpenMS::DriftTimeUnit::NONE
No unit.
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::ProgressLogger::last_invoke_
time_t last_invoke_
Definition: ProgressLogger.h:123
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::ProgressLogger
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:52
OpenMS::ProgressLogger::type_
LogType type_
Definition: ProgressLogger.h:122
OpenMS::ProgressLogger::LogType
LogType
Possible log types.
Definition: ProgressLogger.h:68
OpenMS::ProgressLogger::recursion_depth_
static int recursion_depth_
Definition: ProgressLogger.h:124
OpenMS::SignedSize
ptrdiff_t SignedSize
Signed Size type e.g. used as pointer difference.
Definition: Types.h:134
OpenMS::ProgressLogger::GUI
Progress dialog.
Definition: ProgressLogger.h:71
OpenMS::ProgressLogger::ProgressLoggerImpl::~ProgressLoggerImpl
virtual ~ProgressLoggerImpl()
Definition: ProgressLogger.h:86
OpenMS::ProgressLogger::ProgressLoggerImpl
This class represents an actual implementation of a logger.
Definition: ProgressLogger.h:78
OpenMS::ProgressLogger::current_logger_
ProgressLoggerImpl * current_logger_
Definition: ProgressLogger.h:129
OpenMS::ProgressLogger::CMD
Command line progress.
Definition: ProgressLogger.h:70