Developer Documentation
OpenFlipperThread.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 
45 #ifndef OPENFLIPPERTHREAD_HH
46 #define OPENFLIPPERTHREAD_HH
47 
48 #include <QThread>
49 #include <QSemaphore>
50 
52 
53 
54 class OpenFlipperJob;
55 
77 class DLLEXPORT OpenFlipperThread : public QThread
78 {
79  Q_OBJECT
80 
81  public:
82  explicit OpenFlipperThread( QString _jobId );
84 
85  //===========================================================================
88  //===========================================================================
89  public:
90 
97  void run();
98 
106  virtual void cancel();
107 
111  QString jobId();
112 
113  public slots:
120  void slotCancel( QString _jobId);
121 
122  signals:
131  void state( QString _jobId, int _state );
132 
136  //===========================================================================
139  //===========================================================================
140 
141  signals:
160  void function(const QString _jobId = "");
161 
167  void finished( QString _jobId );
168 
169 
170 
171  public slots:
176  void startProcessing();
177 
181  private slots:
186  void slotJobFinished();
187 
188  signals:
194  void startProcessingInternal();
195 
196  private:
206 
212  QString jobId_;
213 
222  QSemaphore startup_;
223 
224 };
225 
226 
227 // ================================================================================
228 // Job wrapper
229 // ================================================================================
230 
243 class DLLEXPORT OpenFlipperJob : public QObject
244 {
245  Q_OBJECT
246 
247  public:
248  explicit OpenFlipperJob(const QString _jobId) : jobId_(_jobId) {}
249  ~OpenFlipperJob();
250 
251  signals:
259  void process(const QString _jobId = "");
260 
265  void finished();
266 
267  public slots:
273  void startJobProcessing();
274 
275  public:
277  void jobId(const QString& _jobId) { jobId_ = _jobId; }
278 
280  QString jobId() const { return jobId_; }
281 
282  private:
284  QString jobId_;
285 };
286 
287 
288 
289 #endif //OPENFLIPPERTHREAD_HH
QString jobId() const
Get job&#39;s id.
#define DLLEXPORT
QString jobId_
Id of the current job.
QSemaphore startup_
Semaphore to control order of thread startup calls.
OpenFlipperJob * job_
Internal job wrapper.
QString jobId_
The job&#39;s id.
void jobId(const QString &_jobId)
Set job&#39;s id.
Internal Job execution object.
Thread handling class for OpenFlipper.