Main MRPT website > C++ reference
MRPT logo

mrptEvent.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  mrptEvent_H
00029 #define  mrptEvent_H
00030 
00031 #include <mrpt/utils/utils_defs.h>
00032 #include <mrpt/system/datetime.h>
00033 
00034 namespace mrpt
00035 {
00036         namespace utils
00037         {
00038                 class CObservable;
00039 
00040                 /**  The basic event type for the observer-observable pattern in MRPT.
00041                   *   You can sub-class this base class to create custom event types, then
00042                   *    tell between them in runtime with isOfType<T>(), for example:
00043                   * \code
00044                   *   if (e.isOfType<mrptEventOnDestroy>())
00045                   *   {
00046                   *     const mrptEventOnDestroy* ev = e.getAs<mrptEventOnDestroy>();
00047                   *     ev-> ...
00048                   *   }
00049                   * \endcode
00050                   *
00051                   * \sa CObserver, CObservable
00052                   */
00053                 class BASE_IMPEXP mrptEvent
00054                 {
00055                 protected:
00056                         virtual void do_nothing() { } //!< Just to allow this class to be polymorphic
00057                 public:
00058                         /** Default ctor */
00059                         inline mrptEvent() : timestamp(mrpt::system::now()) { }
00060 
00061                         template <class EVENTTYPE>
00062                         inline bool isOfType() const { return dynamic_cast<const EVENTTYPE*>(this)!=NULL; }
00063 
00064                         template <class EVENTTYPE>
00065                         inline const EVENTTYPE* getAs() const { return dynamic_cast<const EVENTTYPE*>(this); }
00066 
00067                         mrpt::system::TTimeStamp  timestamp;
00068 
00069                 }; // End of class def.
00070 
00071                 /**  An event sent by any CObservable object (automatically) just before being destroyed and telling its observers to unsubscribe.
00072                   */
00073                 class BASE_IMPEXP mrptEventOnDestroy : public mrptEvent
00074                 {
00075                 protected:
00076                         virtual void do_nothing() { } //!< Just to allow this class to be polymorphic
00077                 public:
00078                         inline mrptEventOnDestroy(const CObservable *obj) : source_object(obj) { }
00079 
00080                         const CObservable *source_object;
00081 
00082                 }; // End of class def.
00083 
00084         } // End of namespace
00085 } // end of namespace
00086 #endif



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