nucleus/library/timely/stopwatch.h

   1 #ifndef STOPWATCH_CLASS
   2 #define STOPWATCH_CLASS
   3
   4 /*
   5  *  Name   : stopwatch
   6  *  Author : Chris Koeritz
   7  *
   8  * Copyright (c) 1991-$now By Author.  This program is free software; you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation; either version 2 of
  11  * the License or (at your option) any later version.  This is online at:
  12  *     http://www.fsf.org/copyleft/gpl.html
  13  * Please send any updates to: fred@gruntose.com
  14  */
  15
  16 #include "time_stamp.h"
  17
  18 namespace timely {
  19
  20 //! A class for measuring event durations in real time.
  21 /*!
  22   Once the stopwatch is constructed, it can then be repeatedly started and
  23   halted, and then started again.  The number of milliseconds or
  24   microseconds elapsed can be requested while the stopwatch is running, but
  25   that can disrupt fine-grained measurements.
  26 */
  27
  28 class stopwatch : public virtual basis::root_object
  29 {
  30 public:
  31   stopwatch();
  32   stopwatch(const stopwatch &to_copy);
  33
  34   virtual ~stopwatch();
  35
  36   stopwatch &operator =(const stopwatch &to_copy);
  37
  38   void start();
  39     //!< Begins the timing.
  40     /*!< If the stopwatch is already timing, then "start" does nothing. */
  41
  42   void halt();
  43     //!< Stops the timing.
  44     /*!< start() may be called again to resume timing after the halt.  If the
  45     stopwatch is already stopped, or never was started, then halt does nothing. */
  46   void stop() { halt(); }
  47     //!< a synonym for halt().
  48
  49   void reset();
  50     //!< Stops the stopwatch and clears it to zero time elapsed.
  51
  52   int milliseconds();
  53     //!< Returns the elapsed number of milliseconds on the stopwatch, overall.
  54   int elapsed() { return milliseconds(); }
  55     //!< a synonym for milliseconds().
  56
  57 private:
  58   enum stopwatch_kinds { UNSTARTED, RUNNING, STOPPED };  //!< states for the stopwatch.
  59   stopwatch_kinds _status;  //!< our current state.
  60   time_stamp *_start_time;  //!< last time we got started.
  61   time_stamp *_stop_time;  //!< last time we got stopped.
  62   int _total_so_far;  //!< total amount of time run for so far.
  63
  64   int common_measure();
  65     //!< returns the current time used to this point, in milliseconds.
  66
  67   int compute_diff(const time_stamp &t1, const time_stamp &t2);
  68     //!< the difference in milliseconds between the times "t1" and "t2".
  69 };
  70
  71 //////////////
  72
  73 //! Logs a warning when an operation takes longer than expected.
  74 /*!
  75   Place TIME_CHECK_BEGIN before the code that you want to check, then place
  76   TIME_CHECK_END afterwards.  The two calls must be in the same scope.
  77   "logger" should be a reference to a log_base object.   [ by Brit Minor ]
  78 */
  79 #define TIME_CHECK_BEGIN \
  80   stopwatch t; \
  81   t.start();
  82 #define TIME_CHECK_END(logger, who, msec_limit, what, filter) { \
  83   t.halt(); \
  84   if (t.milliseconds() > msec_limit) { \
  85     (logger).log( a_sprintf("TIME_CHECK: %s: %d ms wait for %s.", \
  86         (who), t.milliseconds(), (what)), filter); \
  87   } \
  88 }
  89
  90 } //namespace.
  91
  92 #endif
  93