| OpenMS 2.5.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-2020.
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 #include <map>
40
41 namespace OpenMS
42 {
43 class String;
44
54 class OPENMS_DLLAPI ProgressLogger
55 {
56 public:
58 ProgressLogger();
59
61 ~ProgressLogger();
62
64 ProgressLogger(const ProgressLogger& other);
65
67 ProgressLogger& operator=(const ProgressLogger& other);
68
70 enum LogType
71 {
72 CMD,
73 GUI,
74 NONE
75 };
76
80 class OPENMS_DLLAPI ProgressLoggerImpl
81 {
82 public:
83 virtual void startProgress(const SignedSize begin, const SignedSize end, const String& label, const int current_recursion_depth) const = 0;
84 virtual void setProgress(const SignedSize value, const int current_recursion_depth) const = 0;
85 virtual SignedSize nextProgress() const = 0; //< does not print/show anything; returns current progress
86 virtual void endProgress(const int current_recursion_depth) const = 0;
87
88 virtual ~ProgressLoggerImpl() {}
89
91 static void registerChildren();
92
93 };
94
96 void setLogType(LogType type) const;
97
99 LogType getLogType() const;
100
112 void startProgress(SignedSize begin, SignedSize end, const String& label) const;
113
115 void setProgress(SignedSize value) const;
116
118 void endProgress() const;
119
121 void nextProgress() const;
122
123 protected:
124 mutable LogType type_;
125 mutable time_t last_invoke_;
126 static int recursion_depth_;
127
129 static String logTypeToFactoryName_(LogType type);
130
131 mutable ProgressLoggerImpl* current_logger_;
132
133 };
134
135 } // namespace OpenMS
136
OpenMS::SignedSize
ptrdiff_t SignedSize
Signed Size type e.g. used as pointer difference.
Definition: Types.h:134
OpenMS::ProgressLogger::current_logger_
ProgressLoggerImpl * current_logger_
Definition: ProgressLogger.h:131
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::ProgressLogger::ProgressLoggerImpl::~ProgressLoggerImpl
virtual ~ProgressLoggerImpl()
Definition: ProgressLogger.h:88
OpenMS::ProgressLogger::recursion_depth_
static int recursion_depth_
Definition: ProgressLogger.h:126
OpenMS::ProgressLogger::CMD
Command line progress.
Definition: ProgressLogger.h:72
Types.h
OpenMS::ProgressLogger::ProgressLoggerImpl
This class represents an actual implementation of a logger.
Definition: ProgressLogger.h:80
OpenMS::ProgressLogger::GUI
Progress dialog.
Definition: ProgressLogger.h:73
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::ProgressLogger
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:54
OpenMS::ProgressLogger::LogType
LogType
Possible log types.
Definition: ProgressLogger.h:70
OpenMS::ProgressLogger::last_invoke_
time_t last_invoke_
Definition: ProgressLogger.h:125
OpenMS::ProgressLogger::type_
LogType type_
Definition: ProgressLogger.h:124