Developer Documentation

ProcessInterface.hh
Go to the documentation of this file.
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 #pragma once
43
44 #include <OpenFlipper/threads/OpenFlipperThread.hh>
45
46
60 class ProcessInterface {
61
62 public :
63
65 virtual ~ProcessInterface() {};
66
67 signals :
68
84 virtual void startJob( QString _jobId, QString _description , int _min , int _max , bool _blocking = false) {};
85
93 virtual void setJobState(QString _jobId, int _value ) {};
94
102 virtual void setJobName(QString _jobId, QString _name ) {};
103
111 virtual void setJobDescription(QString _jobId, QString _text ) {};
112
117 virtual void cancelJob(QString _jobId ) {};
118
126 virtual void finishJob(QString _jobId ) {};
127
128 private slots :
129
137 virtual void canceledJob (QString _job ) {};
138
139 };
140
141
298 Q_DECLARE_INTERFACE(ProcessInterface,"OpenFlipper.ProcessInterface/1.0")
299
ProcessInterface::setJobDescription
virtual void setJobDescription(QString _jobId, QString _text)
update job&#39;s description text
Definition: ProcessInterface.hh:111
ProcessInterface::canceledJob
virtual void canceledJob(QString _job)
A job has been canceled.
Definition: ProcessInterface.hh:137
ProcessInterface::cancelJob
virtual void cancelJob(QString _jobId)
Cancel your job.
Definition: ProcessInterface.hh:117
ProcessInterface::setJobState
virtual void setJobState(QString _jobId, int _value)
update job state
Definition: ProcessInterface.hh:93
ProcessInterface::~ProcessInterface
virtual ~ProcessInterface()
Destructor.
Definition: ProcessInterface.hh:65
ProcessInterface::startJob
virtual void startJob(QString _jobId, QString _description, int _min, int _max, bool _blocking=false)
announce a new job
Definition: ProcessInterface.hh:84
ProcessInterface::setJobName
virtual void setJobName(QString _jobId, QString _name)
update job&#39;s name
Definition: ProcessInterface.hh:102
ProcessInterface
Interface class for Thread handling.
Definition: ProcessInterface.hh:60
ProcessInterface::finishJob
virtual void finishJob(QString _jobId)
Finish your job.
Definition: ProcessInterface.hh:126