callbackable.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Robot Group Leipzig                             *
 *    martius@informatik.uni-leipzig.de                                    *
 *    fhesse@informatik.uni-leipzig.de                                     *
 *    der@informatik.uni-leipzig.de                                        *
 *    frankguettler@gmx.de                                                 *
 *                                                                         *
 *   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.             *
 ***************************************************************************
 *                                                                         *
 *  DESCRIPTION                                                            *
 *                                                                         *
 *   $Log: callbackable.h,v $
 *   Revision 1.1  2007/05/07 21:04:44  robot3
 *   added interface class, which provides the possibility, that an implementing class
 *   can have a callback from another class where the implementing class is registered
 *   for the callback.
 *
 *                                                                         *
 ***************************************************************************/
#ifndef _CALLBACKABLE_H
#define _CALLBACKABLE_H

/**
 * Interface class for a class which wants to be callback on a certain action.
 * In lpzrobots this should be the most case when the time loop is going to the
 * next step.
 *
 * Some classes are implementing the method addCallbackable(Callbackable* classname),
 * which should be called for getting a callback.
 */
class Callbackable {

public:

        virtual ~Callbackable() {}

        /**
         *      this method is invoked when a callback is done from the class where this
         * class is for callback registered
         */
        virtual void doOnCallBack() = 0;

};

#endif

---