Robot Simulator of the Robotics Group for Self-Organization of Control: inspectableproxy.h Source File

# inspectableproxy.h

Go to the documentation of this file.

    00001 /***************************************************************************
    00002  *   Copyright (C) 2005-2011 LpzRobots development team                    *
    00003  *    Georg Martius  <georg dot martius at web dot de>                     *
    00004  *    Frank Guettler <guettler at informatik dot uni-leipzig dot de        *
    00005  *    Frank Hesse    <frank at nld dot ds dot mpg dot de>                  *
    00006  *    Ralf Der       <ralfder at mis dot mpg dot de>                       *
    00007  *                                                                         *
    00008  *   This program is free software; you can redistribute it and/or modify  *
    00009  *   it under the terms of the GNU General Public License as published by  *
    00010  *   the Free Software Foundation; either version 2 of the License, or     *
    00011  *   (at your option) any later version.                                   *
    00012  *                                                                         *
    00013  *   This program is distributed in the hope that it will be useful,       *
    00014  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
    00015  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
    00016  *   GNU General Public License for more details.                          *
    00017  *                                                                         *
    00018  *   You should have received a copy of the GNU General Public License     *
    00019  *   along with this program; if not, write to the                         *
    00020  *   Free Software Foundation, Inc.,                                       *
    00021  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
    00022  *                                                                         *
    00023  ***************************************************************************/
    00024
    00025 #ifndef INSPECTABLEPROXY_H_
    00026 #define INSPECTABLEPROXY_H_
    00027
    00028 //includes
    00029 #include <list>
    00030 #include "inspectable.h"
    00031
    00032 /**
    00033  * This class is a proxy for the inspectable class. It "divides" the inspectable interface  from the inspected object
    00034  */
    00035 class InspectableProxy : public Inspectable {
    00036 public:
    00037         /**
    00038          * constructor
    00039          * Takes a list of Inspectables for which the proxy stands.
    00040          * Attention: The inspectables must have registered
    00041          * all their variables already!
    00042          * @param list (list<Inspectable*>&) the list
    00043          */
    00044         InspectableProxy(const std::list<Inspectable*>& list, const iparamkey& name = "InspectableProxy");
    00045
    00046         /**
    00047          * default destructor
    00048          */
    00049         virtual ~InspectableProxy();
    00050
    00051         /**
    00052          * this function is for replacing the old list
    00053          * @param list (list<Inspectable*>& the new list
    00054          * @return (bool) true if it successful
    00055          */
    00056         bool replaceList(const std::list<Inspectable*>& list);
    00057
    00058 private:
    00059         /**
    00060          * the saved list of the Inspectable where the proxy stand for.
    00061          */
    00062         //std::list<Inspectable*> m_list;
    00063
    00064         /**
    00065          * disable the default constructor
    00066          * @return
    00067          */
    00068         InspectableProxy(const iparamkey& name = "InspectableProxy");
    00069 };
    00070
    00071 #endif /* INSPECTABLEPROXY_H_ */