qtjobprocessor.h 2.66 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
// If not explicitly stated otherwise: Copyright (C) 2012-2014, all rights reserved,
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
//      Technische Universitaet Muenchen
//      Boltzmannstr. 3, 85748 Garching b. Muenchen, Germany
// 
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
// except in compliance with the License. You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
// 
// ================================================================================================

#ifndef QTJOBPROCESSOR_H__
#define QTJOBPROCESSOR_H__

#include "core/tools/job.h"
#include "tgt/singleton.h"
#include <QWidget>
#include <functional>

namespace campvis {


    /**
Jakob Weiss's avatar
Jakob Weiss committed
37
38
39
40
41
42
43
44
45
46
47
     * This job processor singleton can be used to execute jobs (asynchronously) from inside the Qt GUI thread.
     * This can result in simpler and better understandable code when only a few lines of code need
     * to be executed in the context, as it removes the need to introduce a new signal and slot just
     * to transition into the Qt GUI thread.
     * 
     * Example:
     * \code
     * QtJobProc.enqueueJob([=](){
     *     _application->_mainWindow->statusBar()->showMessage(QString::fromStdString(status), timeout);
     * });
     * \endcode
48
49
50
51
52
53
54
55
56
57
     */
    class QtJobProcessor : public QWidget, public tgt::Singleton<QtJobProcessor> {
        Q_OBJECT;

    public:
        
        QtJobProcessor();
                
        virtual ~QtJobProcessor();

Jakob Weiss's avatar
Jakob Weiss committed
58
59
60
        /**
         Enqueues a new job to be processed by the job processor
         */
61
62
        void enqueueJob(AbstractJob * job);

Jakob Weiss's avatar
Jakob Weiss committed
63
64
65
        /**
         Convenience function to simplify the code, removing the necessity for a makeJobOnHeap() call
         */
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
        void enqueueJob(std::function<void(void)> fn);

   signals:
        void newJobSignal(AbstractJob * job);

    private slots:
        void onJobArrived(AbstractJob * job);
    };

}

#define QtJobProc tgt::Singleton<campvis::QtJobProcessor>::getRef()


#endif // QTJOBPROCESSOR_H__