OpenMS  3.0.0
GUIProgressLoggerImpl.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: Stephan Aiche, Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
38 
40 
41 class QProgressDialog;
42 
43 namespace OpenMS
44 {
48  class OPENMS_GUI_DLLAPI GUIProgressLoggerImpl :
50  {
51 public:
53  static ProgressLogger::ProgressLoggerImpl* create();
54 
56  static const String getProductName();
57 
60 
64  void startProgress(const SignedSize begin, const SignedSize end, const String& label, const int /* current_recursion_depth */) const override;
65 
69  void setProgress(const SignedSize value, const int /* current_recursion_depth */) const override;
70 
74  SignedSize nextProgress() const override;
75 
79  void endProgress(const int /* current_recursion_depth */) const override;
80 
82  ~GUIProgressLoggerImpl() override;
83 
84 private:
85  mutable QProgressDialog* dlg_;
86  mutable SignedSize begin_;
87  mutable SignedSize end_;
89  };
90 }
91 
OpenMS::GUIProgressLoggerImpl::begin_
SignedSize begin_
Definition: GUIProgressLoggerImpl.h:86
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::GUIProgressLoggerImpl
Implements a GUI version of the ProgressLoggerImpl.
Definition: GUIProgressLoggerImpl.h:48
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::GUIProgressLoggerImpl::end_
SignedSize end_
Definition: GUIProgressLoggerImpl.h:87
ProgressLogger.h
OpenMS::GUIProgressLoggerImpl::current_
SignedSize current_
Definition: GUIProgressLoggerImpl.h:88
OpenMS::SignedSize
ptrdiff_t SignedSize
Signed Size type e.g. used as pointer difference.
Definition: Types.h:134
OpenMS::ProgressLogger::ProgressLoggerImpl
This class represents an actual implementation of a logger.
Definition: ProgressLogger.h:78
OpenMS::GUIProgressLoggerImpl::dlg_
QProgressDialog * dlg_
Definition: GUIProgressLoggerImpl.h:85