ArClientHandlerConfig.h

Go to the documentation of this file.

/*
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 ARCLIENTCONFIGHANDLER_H
#define ARCLIENTCONFIGHANDLER_H

#include "Aria.h"
#include "ArClientBase.h"


class ArClientHandlerConfig
{
public:
  AREXPORT ArClientHandlerConfig(ArClientBase *client,
                                                         bool ignoreBounds = false,
                                 const char *robotName = NULL);
  AREXPORT virtual ~ArClientHandlerConfig(void);

  AREXPORT void requestConfigFromServer(void);
  AREXPORT void reloadConfigOnServer(void);

  AREXPORT ArConfig getConfigCopy(void);

  AREXPORT void addGotConfigCB(ArFunctor *functor, 
                               ArListPos::Pos position = ArListPos::LAST);
  AREXPORT void remGotConfigCB(ArFunctor *functor);
  AREXPORT void addSaveConfigSucceededCB(ArFunctor *functor, 
                           ArListPos::Pos position = ArListPos::LAST);
  AREXPORT void remSaveConfigSucceededCB(ArFunctor *functor);
  AREXPORT void addSaveConfigFailedCB(ArFunctor1<const char *> *functor, 
                           ArListPos::Pos position = ArListPos::LAST);
  AREXPORT void remSaveConfigFailedCB(ArFunctor1<const char *> *functor);

  AREXPORT bool haveGottenConfig(void);
  AREXPORT void saveConfigToServer(void);
  AREXPORT void saveConfigToServer(
          ArConfig *config, 
          const std::set<std::string, 
          ArStrCaseCmpOp> *ignoreTheseSections = NULL);

  AREXPORT bool haveRequestedDefaults(void);
  AREXPORT bool haveGottenDefaults(void);

  AREXPORT bool canRequestDefaults(void);

  AREXPORT bool requestDefaultConfigFromServer(void);
  AREXPORT ArConfig *getDefaultConfig();

  AREXPORT bool requestConfigDefaults(void);
  AREXPORT bool requestSectionDefaults(const char *section);
  

  AREXPORT void addGotConfigDefaultsCB(ArFunctor *functor, 
                           ArListPos::Pos position = ArListPos::LAST);
  AREXPORT void remGotConfigDefaultsCB(ArFunctor *functor);

  AREXPORT ArConfig *getConfig(void);
  AREXPORT int lock(void);
  AREXPORT int tryLock(void);
  AREXPORT int unlock(void);

  AREXPORT void handleGetConfigBySections(ArNetPacket *packet);

  AREXPORT void handleGetConfigSectionFlags(ArNetPacket *packet);

  AREXPORT void handleGetConfig(ArNetPacket *packet);

  AREXPORT void handleSetConfig(ArNetPacket *packet);
  AREXPORT void handleGetConfigDefaults(ArNetPacket *packet);

protected:

  AREXPORT void handleGetConfigData(ArNetPacket *packet,
                                    bool isMultiplePackets);


protected:

  std::string myRobotName;
  std::string myLogPrefix;

  std::list<ArFunctor *> myGotConfigCBList;
  std::list<ArFunctor *> mySaveConfigSucceededCBList;
  std::list<ArFunctor1<const char *> *> mySaveConfigFailedCBList;
  std::list<ArFunctor *> myGotConfigDefaultsCBList;
  ArClientBase *myClient;
  ArConfig myConfig;
  ArConfig *myDefaultConfig;
  ArMutex myDataMutex;
  ArMutex myCallbackMutex;
  bool myHaveGottenConfig;
  bool myHaveRequestedDefaults;
  bool myHaveGottenDefaults;
  bool myHaveRequestedDefaultCopy;

  ArFunctor1C<ArClientHandlerConfig, ArNetPacket *> myHandleGetConfigBySectionsCB;
  ArFunctor1C<ArClientHandlerConfig, ArNetPacket *> myHandleGetConfigCB;
  ArFunctor1C<ArClientHandlerConfig, ArNetPacket *> myHandleSetConfigCB;
  ArFunctor1C<ArClientHandlerConfig, 
      ArNetPacket *> myHandleGetConfigDefaultsCB;
  ArFunctor1C<ArClientHandlerConfig, 
      ArNetPacket *> myHandleGetDefaultConfigCB;
  ArFunctor1C<ArClientHandlerConfig, 
              ArNetPacket *> myHandleGetConfigSectionFlagsCB;
};

#endif

---