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 CObservable_H 00029 #define CObservable_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 CObserver; 00039 00040 /** Inherit from this class for those objects capable of being observed by a CObserver class. 00041 * 00042 * The only thing to do in your child class is to call CObservable::publishEvent() whenever needed and all the 00043 * observer classes will be notified. 00044 * 00045 * \note The pairs CObservable / CObserver automatically notify each other the destruction of any of them, effectively ending the subscription of events. 00046 * 00047 * \sa CObserver, mrptEvent 00048 */ 00049 class BASE_IMPEXP CObservable 00050 { 00051 friend class CObserver; 00052 00053 public: 00054 CObservable(); 00055 virtual ~CObservable(); 00056 00057 private: 00058 std::set<CObserver*> m_subscribers; 00059 void internal_observer_begin(CObserver*); 00060 void internal_observer_end(CObserver*); 00061 00062 protected: 00063 /** Called when you want this object to emit an event to all the observers currently subscribed to this object. 00064 */ 00065 void publishEvent(const mrptEvent &e) const; 00066 00067 }; // End of class def. 00068 00069 } // End of namespace 00070 } // end of namespace 00071 #endif
Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011 |