ArClientData.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 ARCLIENTDATA_H
#define ARCLIENTDATA_H

#include "Aria.h"
class ArNetPacket;


class ArClientData
{
public:
  AREXPORT ArClientData(const char *name, const char *description, 
                        unsigned int command, 
                        ArFunctor1<ArNetPacket *> *functor);
  AREXPORT virtual ~ArClientData();
  const char *getName(void) { return myName.c_str(); }
  const char *getDescription(void) { return myDescription.c_str(); }
  unsigned int getCommand(void) { return myCommand; }
  const char *getArgumentDescription(void) 
    { return myArgumentDescription.c_str(); }
  const char *getReturnDescription(void) 
    { return myReturnDescription.c_str(); }
  const char *getCommandGroup(void) { return myCommandGroup.c_str(); }
  AREXPORT bool hasDataFlag(const char *dataFlag);
  const char *getDataFlagsString(void) 
    { return myDataFlagsBuilder.getFullString(); }
  const std::list<ArFunctor1<ArNetPacket *> *> *getFunctorList(void) const
    { return &myFunctorList; };
  AREXPORT int lockFunctorList(void) { return myMutex.lock(); }
  AREXPORT int tryLockFunctorList(void) { return myMutex.tryLock(); }
  AREXPORT int unlockFunctorList(void) { return myMutex.unlock(); }
  
  void addFunctor(ArFunctor1<ArNetPacket *> *functor) 
    { myFunctorList.push_back(functor); }
  void remFunctor(ArFunctor1<ArNetPacket *> *functor) 
    { myFunctorList.remove(functor); }
  void setArgRetDescs(const char *argDesc, const char *retDesc)
    { myArgumentDescription = argDesc; myReturnDescription = retDesc; }
  void setCommandGroup(const char *commandGroup) 
    { myCommandGroup = commandGroup; }
  AREXPORT void addDataFlags(const char *dataFlags);
protected:
  std::string myName;
  std::string myDescription;
  unsigned int myCommand;
  std::string myArgumentDescription;
  std::string myReturnDescription;
  std::string myCommandGroup;
  ArMutex myDataMutex;
  ArArgumentBuilder myDataFlagsBuilder;
  ArMutex myMutex;
  std::list<ArFunctor1<ArNetPacket *> *> myFunctorList;
};

#endif // ARCLIENTDATA_H

---