Main MRPT website > C++ reference
MRPT logo

CStartUpClassesRegister.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  CStartUpClassesRegister_H
00029 #define  CStartUpClassesRegister_H
00030 
00031 #include <mrpt/utils/utils_defs.h>
00032 
00033 namespace mrpt
00034 {
00035         namespace utils
00036         {
00037                 /** A helper class that automatically register at start up a custom function to register all the CObject-derived classes in a given MRPT library or user application.
00038                   *   Usage:
00039                   *  \code
00040                   *    void registerAllMyClasses()
00041                   *    {
00042                   *      registerClass(CLASS_ID( CMyClass1 ) );
00043                   *      ...
00044                   *    }
00045                   *
00046                   *    CStartUpClassesRegister   doReg( &registerAllMyClasses );
00047                   *
00048                   *  \endcode
00049                   */
00050                 class BASE_IMPEXP CStartUpClassesRegister
00051                 {
00052                 public:
00053                         /** Read the global description of mrpt::utils::CStartUpClassesRegister */
00054                         CStartUpClassesRegister(void (*ptr_register_func)() );
00055                         ~CStartUpClassesRegister();
00056 
00057                         int do_nothing(); //!<< dummy method to allow introducing dependences and avoid the compiler removing the class in static linking
00058 
00059                 private:
00060                         void (*m_ptr_register_func)();  //!< An internal copy of the functor.
00061 
00062                         int m_dummy_var;
00063                 };
00064 
00065 
00066         } // End of namespace
00067 } // End of namespace
00068 
00069 #endif



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