Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages | Examples

ArRecurrentTask.h

00001 /*
00002 MobileRobots Advanced Robotics Interface for Applications (ARIA)
00003 Copyright (C) 2004, 2005 ActivMedia Robotics LLC
00004 Copyright (C) 2006, 2007 MobileRobots Inc.
00005 
00006      This program is free software; you can redistribute it and/or modify
00007      it under the terms of the GNU General Public License as published by
00008      the Free Software Foundation; either version 2 of the License, or
00009      (at your option) any later version.
00010 
00011      This program is distributed in the hope that it will be useful,
00012      but WITHOUT ANY WARRANTY; without even the implied warranty of
00013      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014      GNU General Public License for more details.
00015 
00016      You should have received a copy of the GNU General Public License
00017      along with this program; if not, write to the Free Software
00018      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00019 
00020 If you wish to redistribute ARIA under different terms, contact 
00021 MobileRobots for information about a commercial version of ARIA at 
00022 robots@mobilerobots.com or 
00023 MobileRobots Inc, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
00024 */
00025 
00026 // ArRecurrentTask.h -- Recurrent async task interface class
00027 #ifndef ARRECURASYNCTASK_H
00028 #define ARRECURASYNCTASK_H
00029 
00030 
00031 #include "ariaTypedefs.h"
00032 #include "ArFunctor.h"
00033 #include "ArThread.h"
00034 #include "ArASyncTask.h"
00035 
00037 
00055 class ArRecurrentTask : public ArASyncTask
00056 {
00057 public:
00059   AREXPORT ArRecurrentTask();
00061   AREXPORT ~ArRecurrentTask();  
00063 
00066   virtual void task() = 0;
00068   AREXPORT void go();       
00070 
00073   AREXPORT int  done(); 
00075   AREXPORT void reset();    // stops the current thread and restarts it
00076   AREXPORT void kill();         // kills the current thread
00077 
00078   AREXPORT void *runThread(void *ptr); // main task loop
00079 
00080 private:
00081   bool running;         // true if currently running
00082   bool go_req;          // run request
00083   bool killed;          // did we get killed by request?
00084 };
00085 
00086 
00087 #endif // ARRECURASYNCTASK_H

Generated on Tue Feb 20 10:51:41 2007 for Aria by  doxygen 1.4.0