Main MRPT website > C++ reference
MRPT logo

CObserver.h

Go to the documentation of this file.
00001 /* +---------------------------------------------------------------------------+
00002    |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
00003    |                                                                           |
00004    |                   http://mrpt.sourceforge.net/                            |
00005    |                                                                           |
00006    |   Copyright (C) 2005-2011  University of Malaga                           |
00007    |                                                                           |
00008    |    This software was written by the Machine Perception and Intelligent    |
00009    |      Robotics Lab, University of Malaga (Spain).                          |
00010    |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
00011    |                                                                           |
00012    |  This file is part of the MRPT project.                                   |
00013    |                                                                           |
00014    |     MRPT is free software: you can redistribute it and/or modify          |
00015    |     it under the terms of the GNU General Public License as published by  |
00016    |     the Free Software Foundation, either version 3 of the License, or     |
00017    |     (at your option) any later version.                                   |
00018    |                                                                           |
00019    |   MRPT is distributed in the hope that it will be useful,                 |
00020    |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |
00021    |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |
00022    |     GNU General Public License for more details.                          |
00023    |                                                                           |
00024    |     You should have received a copy of the GNU General Public License     |
00025    |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
00026    |                                                                           |
00027    +---------------------------------------------------------------------------+ */
00028 #ifndef  CObserver_H
00029 #define  CObserver_H
00030 
00031 #include <mrpt/utils/utils_defs.h>
00032 #include <mrpt/utils/mrptEvent.h>
00033 
00034 namespace mrpt
00035 {
00036         namespace utils
00037         {
00038                 class CObservable;
00039 
00040                 /** Inherit from this class to get notified about events from any CObservable object after subscribing to it.
00041                   *
00042                   *  The main methods in this class are:
00043                   *   - observeBegin(): To be called to start listening at a given object.
00044                   *   - OnEvent(): Virtual functions to be implemented in your child class to receive all the notifications. 
00045                   *
00046                   *  Note that if custom (child) mrptEvent classes are used, you can tell between them in runtime with "dynamic_cast<>()". 
00047                   *
00048                   * \note The pairs CObservable / CObserver automatically notify each other the destruction of any of them, effectively ending the subscription of events.
00049                   *
00050                   *  \sa CObservable, mrptEvent
00051                   */
00052                 class BASE_IMPEXP CObserver
00053                 {
00054                         friend class CObservable;
00055 
00056                 public:
00057                         CObserver();
00058                         virtual ~CObserver();
00059 
00060                         /** Starts the subscription of this observer to the given object.  \sa observeEnd  */
00061                         void observeBegin(CObservable &obj);
00062 
00063                         /** Ends the subscription of this observer to the given object (note that there is no need to call this method, since the destruction of the first of observer/observed will put an end to the process
00064                             \sa observeBegin  */
00065                         void observeEnd(CObservable &obj);
00066 
00067                 private:
00068                         std::set<CObservable*>  m_subscribed; 
00069                         void internal_on_event(const mrptEvent &e);
00070 
00071                 protected:
00072                         /** This virtual function will be called upon receive of any event after starting listening at any CObservable object.
00073                           */
00074                         virtual void OnEvent(const mrptEvent &e) = 0;
00075 
00076                 }; // End of class def.
00077 
00078         } // End of namespace
00079 } // end of namespace
00080 #endif



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011