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

ArMode.h

00001 /*
00002 ActivMedia Robotics Interface for Applications (ARIA)
00003 Copyright (C) 2004,2005 ActivMedia Robotics, LLC
00004 
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 ActivMedia Robotics for information about a commercial version of ARIA at 
00022 robots@activmedia.com or 
00023 ActivMedia Robotics, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
00024 
00025 */
00026 
00027 #ifndef ARMODE_H
00028 #define ARMODE_H
00029 
00030 #include "ariaTypedefs.h"
00031 #include "ArFunctor.h"
00032 #include <string>
00033 #include <list>
00034 
00035 class ArRobot;
00036 
00037 
00039 
00051 class ArMode 
00052 {
00053 public:
00055   ArMode(ArRobot *robot, const char *name, char key, char key2);
00057   virtual ~ArMode();
00059   const char *getName(void);
00061   virtual void activate(void) = 0;
00063   virtual void deactivate(void) = 0;
00065   virtual void userTask(void) {}
00067 
00071   virtual void help(void) {}
00074   bool baseActivate(void); 
00077   bool baseDeactivate(void);
00079   static void baseHelp(void);
00081   char getKey(void);
00083   char getKey2(void);
00084 protected:
00085   void addKeyHandler(int keyToHandle, ArFunctor *functor);
00086   void remKeyHandler(ArFunctor *functor);
00087   // Our activeArMode
00088   static ArMode *ourActiveMode;
00089   std::string myName;
00090   ArRobot *myRobot;
00091   ArFunctorC<ArMode> myActivateCB;
00092   ArFunctorC<ArMode> myDeactivateCB;
00093   ArFunctorC<ArMode> myUserTaskCB;
00094   char myKey;
00095   char myKey2;
00096   // our help callback, its NULL until its initialized
00097   static ArGlobalFunctor *ourHelpCB;
00098   static std::list<ArMode *> ourModes;
00099 };
00100 
00101 #endif // ARMODE_H

Generated on Wed Oct 19 12:56:36 2005 for Aria by  doxygen 1.4.0