Main MRPT website > C++ reference
MRPT logo

CTicTac.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  CTICTAC_H
00029 #define  CTICTAC_H
00030 
00031 #include <mrpt/utils/utils_defs.h>
00032 
00033 namespace mrpt
00034 {
00035 namespace utils
00036 {
00037         /** This class implements a high-performance stopwatch.
00038          *  Typical resolution is about 1e-6 seconds.
00039          *  \note The class is named after the Spanish equivalent of "Tic-Toc" ;-)
00040          */
00041         class BASE_IMPEXP CTicTac
00042         {
00043         private:
00044                 uint8_t         largeInts[64];
00045         public:
00046                 /** Default constructor.
00047                  */
00048                 CTicTac();
00049 
00050                 /** Destructor.
00051                  */
00052                 virtual ~CTicTac();
00053 
00054                 CTicTac(const CTicTac& o)
00055                 {
00056                         THROW_EXCEPTION("CTicTac objects cannot be copied.");
00057                 }
00058 
00059                 CTicTac & operator =(const CTicTac& o)
00060                 {
00061                         THROW_EXCEPTION("CTicTac objects cannot be copied.");
00062                 }
00063 
00064                 /** Starts the stopwatch
00065                  * \sa Tac
00066                  */
00067                 void    Tic();
00068 
00069                 /** Stops the stopwatch
00070                  * \return Returns the ellapsed time in seconds.
00071                  * \sa Tic
00072                  */
00073                 double  Tac();
00074 
00075         }; // End of class def.
00076 
00077         } // End of namespace
00078 } // End of namespace
00079 #endif



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