ArConfigArg.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 ARCONFIGARG_H
#define ARCONFIGARG_H

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

class ArArgumentBuilder;


class ArConfigArg
{
public:

  typedef enum 
  { 
    INVALID, 
    INT, 
    DOUBLE, 
    STRING, 
    BOOL, 
    FUNCTOR, 
    DESCRIPTION_HOLDER, 
    STRING_HOLDER, 
    SEPARATOR, 
    LAST_TYPE = SEPARATOR 
  } Type;

  enum {
    TYPE_COUNT = LAST_TYPE + 1 
  };

  AREXPORT ArConfigArg();
  AREXPORT ArConfigArg(const char * name, int *pointer, 
               const char * description = "", 
               int minInt = INT_MIN, 
               int maxInt = INT_MAX); 
  AREXPORT ArConfigArg(const char * name, short *pointer, 
               const char * description = "", 
               int minInt = SHRT_MIN, 
               int maxInt = SHRT_MAX); 
  AREXPORT ArConfigArg(const char * name, unsigned short *pointer, 
               const char * description = "", 
               int minInt = 0, 
               int maxInt = USHRT_MAX); 
  AREXPORT ArConfigArg(const char * name, unsigned char *pointer, 
               const char * description = "", 
               int minInt = 0,
               int maxInt = 255); 
  AREXPORT ArConfigArg(const char * name, double *pointer,
               const char * description = "", 
               double minDouble = -HUGE_VAL,
               double maxDouble = HUGE_VAL); 
  AREXPORT ArConfigArg(const char * name, bool *pointer,
               const char * description = ""); 
  AREXPORT ArConfigArg(const char *name, char *str, 
               const char *description,
               size_t maxStrLen);
  AREXPORT ArConfigArg(const char * name, int val, 
               const char * description = "", 
               int minInt = INT_MIN, 
               int maxInt = INT_MAX); 
  AREXPORT ArConfigArg(const char * name, double val,
               const char * description = "", 
               double minDouble = -HUGE_VAL,
               double maxDouble = HUGE_VAL); 
  AREXPORT ArConfigArg(const char * name, bool val,
               const char * description = ""); 
  AREXPORT ArConfigArg(const char *name, 
         ArRetFunctor1<bool, ArArgumentBuilder *> *setFunctor, 
         ArRetFunctor<const std::list<ArArgumentBuilder *> *> *getFunctor,
         const char *description);

  AREXPORT ArConfigArg(const char *str, Type type = DESCRIPTION_HOLDER);
  AREXPORT ArConfigArg(const char *name, const char *str);
  AREXPORT ArConfigArg(Type type);


  AREXPORT ArConfigArg(const ArConfigArg & arg);
  AREXPORT ArConfigArg &operator=(const ArConfigArg &arg);
  AREXPORT virtual ~ArConfigArg();

  AREXPORT ArConfigArg::Type getType(void) const;
  AREXPORT const char *getName(void) const;
  AREXPORT const char *getDescription(void) const;


  AREXPORT bool setInt(int val, char *errorBuffer = NULL,
               size_t errorBufferLen = 0, bool doNotSet = false);
  AREXPORT bool setDouble(double val, char *errorBuffer = NULL,
              size_t errorBufferLen = 0, bool doNotSet = false);
  AREXPORT bool setBool(bool val, char *errorBuffer = NULL,
            size_t errorBufferLen = 0, bool doNotSet = false);
  AREXPORT bool setString(const char *str, char *errorBuffer = NULL,
              size_t errorBufferLen = 0, bool doNotSet = false);
  AREXPORT bool setArgWithFunctor(ArArgumentBuilder *argument, 
                  char *errorBuffer = NULL,
                  size_t errorBufferLen = 0,
                  bool doNotSet = false);

  AREXPORT int getInt(void) const; 
  AREXPORT double getDouble(void) const;
  AREXPORT bool getBool(void) const;
  AREXPORT const char *getString(void) const;
  AREXPORT const std::list<ArArgumentBuilder *> *getArgsWithFunctor(void) const;

  AREXPORT void log(bool verbose = false) const;
  
  AREXPORT int getMinInt(void) const;
  AREXPORT int getMaxInt(void) const;
  AREXPORT double getMinDouble(void) const;
  AREXPORT double getMaxDouble(void) const;

  AREXPORT ArPriority::Priority getConfigPriority(void) const;
  AREXPORT void setConfigPriority(ArPriority::Priority priority);

  AREXPORT const char *getDisplayHint() const;
  AREXPORT void setDisplayHint(const char *hintText);

  AREXPORT void setIgnoreBounds(bool ignoreBounds = false);

  AREXPORT bool isValueEqual(const ArConfigArg &other) const;
  
  bool isValueSet(void) { return myValueSet; }
  
  void clearValueSet(void) { myValueSet = false; }
  
private:
  void clear(void);
  void copy(const ArConfigArg &arg);
  
  void set(ArConfigArg::Type type,
           const char *name,
           const char *description);

protected:
  enum IntType {
    INT_NOT, 
    INT_INT, 
    INT_SHORT, 
    INT_UNSIGNED_SHORT, 
    INT_UNSIGNED_CHAR 
  };
  
  ArConfigArg::Type myType;
  std::string myName;
  std::string myDescription;
  bool myOwnPointedTo;
  int *myIntPointer;
  short *myIntShortPointer;
  unsigned short *myIntUnsignedShortPointer;
  unsigned char *myIntUnsignedCharPointer;
  int myMinInt, myMaxInt;
  double *myDoublePointer;
  double myMinDouble, myMaxDouble;
  bool *myBoolPointer;
  char *myStringPointer;
  size_t myMaxStrLen;
  bool myUsingOwnedString;
  std::string myString;
  ArPriority::Priority myConfigPriority;
  ArConfigArg::IntType myIntType;
  bool myIgnoreBounds;
  ArRetFunctor1<bool, ArArgumentBuilder *> *mySetFunctor;
  ArRetFunctor<const std::list<ArArgumentBuilder *> *> *myGetFunctor;
  std::string myDisplayHint;
  bool myValueSet;
};

#endif // ARARGUMENT_H

---