Main Page | Namespace List | Alphabetical List | Class List | Directories | File List | Class Members | File Members

PerformanceTimer.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  *   SpikeStream Library                                                   *
00003  *   Copyright (C) 2007 by David Gamez                                     *
00004  *   david@davidgamez.eu                                                   *
00005  *   Version 0.1                                                           *
00006  *                                                                         *
00007  *   This program is free software; you can redistribute it and/or modify  *
00008  *   it under the terms of the GNU General Public License as published by  *
00009  *   the Free Software Foundation; either version 2 of the License, or     *
00010  *   (at your option) any later version.                                   *
00011  *                                                                         *
00012  *   This program is distributed in the hope that it will be useful,       *
00013  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00014  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
00015  *   GNU General Public License for more details.                          *
00016  *                                                                         *
00017  *   You should have received a copy of the GNU General Public License     *
00018  *   along with this program; if not, write to the                         *
00019  *   Free Software Foundation, Inc.,                                       *
00020  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
00021  ***************************************************************************/
00022 
00023 #ifndef PERFORMANCETIMER_H
00024 #define PERFORMANCETIMER_H
00025 
00026 //Other includes
00027 #include <string>
00028 using namespace std;
00029 
00030 
00031 //--------------------------- Performance Timer ----------------------------
00032 /*! Simple timer to record the time taken for methods or processes in the 
00033         simulation. */
00034 //--------------------------------------------------------------------------
00035 
00036 class PerformanceTimer {
00037 
00038         public:
00039                 PerformanceTimer();
00040                 ~PerformanceTimer();
00041                 unsigned int getTime_usec();
00042                 void printTime();
00043                 void start(string procName);
00044                 void stop();
00045 
00046 
00047         private:
00048                 //============================== VARIABLES =============================
00049                 /*! Time structures to record the start time.*/
00050                 timeval startTime;
00051 
00052                 /*! Time structures to record the start time.*/
00053                 timeval endTime;
00054 
00055                 /*! Name of the process or method that is being timed.*/
00056                 string processName;
00057 
00058                 /*! When the timer is running this is set to false. Setting this
00059                         to true stops the timer and end time is no longer updated.*/
00060                 bool timerStopped;
00061 
00062 
00063                 //=============================== METHODS ==============================
00064                 /*! Declare copy constructor private so it cannot be used inadvertently.*/
00065                 PerformanceTimer (const PerformanceTimer&);
00066 
00067                 /*! Declare assignment private so it cannot be used.*/
00068                 PerformanceTimer operator = (const PerformanceTimer&);
00069 
00070 };
00071 
00072 
00073 #endif//PERFORMANCETIMER_H
00074 

Generated on Mon Sep 3 22:18:50 2007 for SpikeStream Library by  doxygen 1.4.4