RSC  0.17.1
Task.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is a part of the RSC project
4  *
5  * Copyright (C) 2010 by Sebastian Wrede <swrede at techfak dot uni-bielefeld dot de>
6  *
7  * This file may be licensed under the terms of the
8  * GNU Lesser General Public License Version 3 (the ``LGPL''),
9  * or (at your option) any later version.
10  *
11  * Software distributed under the License is distributed
12  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
13  * express or implied. See the LGPL for the specific language
14  * governing rights and limitations.
15  *
16  * You should have received a copy of the LGPL along with this
17  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
18  * or write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The development of this software was supported by:
22  * CoR-Lab, Research Institute for Cognition and Robotics
23  * Bielefeld University
24  *
25  * ============================================================ */
26 
27 #pragma once
28 
29 #include <boost/shared_ptr.hpp>
30 
31 #include "../logging/Logger.h"
32 #include "../misc/langutils.h"
33 #include "rsc/rscexports.h"
34 
35 namespace rsc {
36 namespace threading {
37 
52 class RSC_EXPORT Task {
53 public:
54 
55  virtual ~Task();
56 
61  virtual void cancel() = 0;
62 
68  virtual bool isCancelRequested() = 0;
69 
79  virtual void run() = 0;
80 
88  virtual bool isDone() = 0;
89 
99  virtual void waitDone() = 0;
100 
101 };
102 
103 typedef boost::shared_ptr<Task> TaskPtr;
104 
105 }
106 }
107 
A task is a self.contained piece of work that can be executed by another thread.
Definition: Task.h:52
boost::shared_ptr< Task > TaskPtr
Definition: Task.h:103