Developer Documentation
ProgressEmitter.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef PROGRESSEMITTER_HH
51 #define PROGRESSEMITTER_HH
52 
53 #include <QObject>
55 
56 class ProgressEmitter : public QObject
57 {
58  Q_OBJECT
59 
60  signals:
61  void signalJobState(QString _jobId, int _value);
62  void changeDescription(QString _jobId, QString _description);
63 
64  void backupRequest(int _objId, QString _desc);
65 
66  public:
67  ProgressEmitter() : valid_(false) {}
68 
69  void attachJob(const QString& _jobId) {
70  jobId_ = _jobId;
71  valid_ = true;
72  }
73 
74  void detachJob() {
75  jobId_ = "";
76  valid_ = false;
77  }
78 
79  void sendProgressSignal(double _percent) {
80  if(!valid_) return;
81  emit signalJobState(jobId_, (int)_percent);
82 // std::cerr << "Job State for " << jobId_.toStdString() << ": " << (int)_percent << "%" << std::endl;
83  }
84 
85  void sendChangeDescriptionSignal(QString _description) {
86  if(!valid_) return;
87  emit changeDescription(jobId_, _description);
88 // std::cerr << "Job description for " << jobId_.toStdString() << ": '" << _description.toStdString() << "'" << std::endl;
89  }
90 
91  private:
92  QString jobId_;
93 
94  bool valid_;
95 };
96 
97 
98 #endif //PROGRESSEMITTER_HH