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

# configurablelist.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 __CONFIGURABLELIST_H_
    00026 #define __CONFIGURABLELIST_H_
    00027
    00028 #include <vector>
    00029 #include "configurable.h"
    00030
    00031 /**
    00032  * Establishes for some methods the notifications for registered Callbackable instances
    00033  * (use addCallbackable(...)).
    00034  * @warning Only the following methods are currently supported:
    00035     push_back(...), pop_back(), erase() and clear()!
    00036  * You can use iterators with the limitation to not delete or insert.
    00037  */
    00038 class ConfigurableList : public std::vector<Configurable*>, public BackCaller {
    00039   public:
    00040     ConfigurableList();
    00041     virtual ~ConfigurableList();
    00042
    00043     /**
    00044      * Indicates that the list has been modified, a Configurable instance was either added or removed.
    00045      */
    00046     static const CallbackableType CALLBACK_CONFIGURABLE_LIST_MODIFIED = 3;
    00047
    00048     /**
    00049      * Indicates that the list is being deleted.
    00050      */
    00051     static const CallbackableType CALLBACK_CONFIGURABLE_LIST_BEING_DELETED = 4;
    00052
    00053     void push_back(Configurable* const & configurable);
    00054     iterator erase(iterator pos);
    00055     void pop_back();
    00056     void clear();
    00057 };
    00058
    00059 #endif /* __CONFIGURABLELIST_H_ */