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

# mediatorcollegue.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 #ifndef __MEDIATORCOLLEGUE_H_
    00025 #define __MEDIATORCOLLEGUE_H_
    00026
    00027 //#include "mediator.h"
    00028
    00029 class Mediator;
    00030 class MediatorEvent;
    00031
    00032 class MediatorCollegue
    00033 {
    00034   public:
    00035     typedef unsigned long InformMediatorType;
    00036
    00037     static const InformMediatorType DEFAULT_INFORM_MEDIATOR_TYPE = 0;
    00038
    00039     MediatorCollegue(Mediator* myMediator = 0);
    00040     virtual ~MediatorCollegue();
    00041
    00042     /**
    00043      * Calls the mediator that this collegue has performed something.
    00044      * The event and the instance of this class is handed over.
    00045      */
    00046     void informMediator(MediatorEvent* event);
    00047
    00048     /**
    00049      * Is called when the mediator informs this collegue that an event
    00050      * has to be performed by this collegue instance.
    00051      */
    00052     virtual void doOnMediatorCallBack(MediatorEvent* event) = 0;
    00053
    00054   protected:
    00055
    00056     /**
    00057      * Sets the own mediator. Useful if mediator is unknown in initialization.
    00058      * @param myMediator
    00059      */
    00060     void setMediator(Mediator* myMediator);
    00061
    00062
    00063   private:
    00064
    00065     Mediator* myMediator;
    00066 };
    00067
    00068 #endif /* _MEDIATORCOLLEGUE_H_ */