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

ArActionMovementParameters.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 #ifndef ARACTIONMOVEMENTPARAMTERS_H
00027 #define ARACTIONMOVEMENTPARAMTERS_H
00028 
00029 #include "ariaTypedefs.h"
00030 #include "ArAction.h"
00031 #include "ArMap.h"
00032 
00034 
00036 class ArActionMovementParameters : public ArAction
00037 {
00038 public: 
00040   AREXPORT ArActionMovementParameters(const char *name = "MovementParameters",
00041                       bool overrideFaster = true);
00043   AREXPORT virtual ~ArActionMovementParameters();
00044   AREXPORT virtual ArActionDesired *fire(ArActionDesired currentDesired);
00045   AREXPORT virtual ArActionDesired *getDesired(void) { return &myDesired; }
00046 #ifndef SWIG
00047   AREXPORT virtual const ArActionDesired *getDesired(void) const 
00048                                                         { return &myDesired; }
00049 #endif
00050 
00051   AREXPORT void enable(void) { myEnabled = true; }
00053   AREXPORT void enableOnceFromSector(ArMapObject *mapObject) 
00054     { myEnableOnce = true; }
00056   AREXPORT void disable(void) { myEnabled = false; }
00058   AREXPORT void setParameters(double maxVel = 0, double maxNegVel = 0,
00059                   double transAccel = 0, double transDecel = 0,
00060                   double rotVelMax = 0, double rotAccel = 0,
00061                   double rotDecel = 0);
00063   AREXPORT void addToConfig(ArConfig *config, const char *section,
00064                 const char *prefix = NULL);
00065 protected:
00066   bool myEnabled;
00067   bool myEnableOnce;
00068   bool myOverrideFaster;
00069   double myMaxVel;
00070   double myMaxNegVel;
00071   double myTransAccel;
00072   double myTransDecel;
00073   double myMaxRotVel;
00074   double myRotAccel;
00075   double myRotDecel;
00076   
00077   ArActionDesired myDesired;
00078 
00079 
00080 };
00081 
00082 #endif // ARACTIONMOVEMENTPARAMTERS_H

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