ArArg.h

/*
MobileRobots Advanced Robotics Interface for Applications (ARIA)
Copyright (C) 2004, 2005 ActivMedia Robotics LLC
Copyright (C) 2006, 2007 MobileRobots Inc.

     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.

     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

If you wish to redistribute ARIA under different terms, contact 
MobileRobots for information about a commercial version of ARIA at 
robots@mobilerobots.com or 
MobileRobots Inc, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
*/

#ifndef ARARG_H
#define ARARG_H

#include "ariaTypedefs.h"
#include "ariaUtil.h"
#include "ArFunctor.h"

class ArArgumentBuilder;


class ArArg
{
public:
  typedef enum 
  { 
    INVALID, 
    INT, 
    DOUBLE, 
    STRING, 
    BOOL, 
    POSE, 
    FUNCTOR, 
    DESCRIPTION_HOLDER, 
    
    LAST_TYPE = DESCRIPTION_HOLDER  
  } Type;


  enum {
    TYPE_COUNT = LAST_TYPE + 1 
  };

  AREXPORT ArArg();
  AREXPORT ArArg(const char * name, int *pointer, 
         const char * description = "", 
         int minInt = INT_MIN, 
         int maxInt = INT_MAX); 
  AREXPORT ArArg(const char * name, double *pointer,
         const char * description = "", 
         double minDouble = -HUGE_VAL,
         double maxDouble = HUGE_VAL); 
  AREXPORT ArArg(const char * name, bool *pointer,
         const char * description = ""); 
  AREXPORT ArArg(const char * name, ArPose *pointer,
         const char * description = ""); 
  AREXPORT ArArg(const char *name, char *pointer, 
         const char *description,
         size_t maxStrLen);
  AREXPORT ArArg(const char *name, 
         ArRetFunctor1<bool, ArArgumentBuilder *> *setFunctor, 
         ArRetFunctor<const std::list<ArArgumentBuilder *> *> *getFunctor,
         const char *description);
  AREXPORT ArArg(const char *description);
  AREXPORT ArArg(const ArArg & arg);
  AREXPORT ArArg &operator=(const ArArg &arg);
  AREXPORT virtual ~ArArg();

  AREXPORT Type getType(void) const;
  AREXPORT const char *getName(void) const;
  AREXPORT const char *getDescription(void) const;
  AREXPORT bool setInt(int val);
  AREXPORT bool setDouble(double val);
  AREXPORT bool setBool(bool val);
  AREXPORT bool setPose(ArPose pose);
  AREXPORT bool setString(const char *str);
  AREXPORT bool setArgWithFunctor(ArArgumentBuilder *argument);
  AREXPORT int getInt(void) const; 
  AREXPORT double getDouble(void) const;
  AREXPORT bool getBool(void) const;
  AREXPORT ArPose getPose(void) const;
  AREXPORT const char *getString(void) const;
  AREXPORT const std::list<ArArgumentBuilder *> *getArgsWithFunctor(void) const;
  AREXPORT void log(void) const;
  AREXPORT int getMinInt(void) const;
  AREXPORT int getMaxInt(void) const;
  AREXPORT double getMinDouble(void) const;
  AREXPORT double getMaxDouble(void) const;
  AREXPORT bool getConfigPrioritySet(void) const;
  AREXPORT ArPriority::Priority getConfigPriority(void) const;
  AREXPORT void setConfigPriority(ArPriority::Priority priority);

private:
  AREXPORT void clear(void);

protected:

  ArArg::Type myType;
  std::string myName;
  std::string myDescription;
  int *myIntPointer;
  int myMinInt, myMaxInt;
  double *myDoublePointer;
  double myMinDouble, myMaxDouble;
  bool *myBoolPointer;
  ArPose *myPosePointer;
  char *myStringPointer;
  size_t myMaxStrLen;
  bool myConfigPrioritySet;
  ArPriority::Priority myConfigPriority;
  ArRetFunctor1<bool, ArArgumentBuilder *> *mySetFunctor;
  ArRetFunctor<const std::list<ArArgumentBuilder *> *> *myGetFunctor;
};

#endif // ARARGUMENT_H

---