src/timer.h

   1 /****************************
   2 ** Tsunagari Tile Engine   **
   3 ** timer.h                 **
   4 ** Copyright 2012 OmegaSDG **
   5 ****************************/
   6
   7 // **********
   8 // Permission is hereby granted, free of charge, to any person obtaining a copy
   9 // of this software and associated documentation files (the "Software"), to
  10 // deal in the Software without restriction, including without limitation the
  11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  12 // sell copies of the Software, and to permit persons to whom the Software is
  13 // furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  24 // IN THE SOFTWARE.
  25 // **********
  26
  27 #ifndef TIMER_H
  28 #define TIMER_H
  29
  30 #include <ctime> // for time_t
  31 #include <string>
  32
  33 // Note: This will break if run long enough for the counter to overflow.
  34
  35 //! A timer class for timing Python events.
  36 class Timer {
  37 public:
  38         Timer();
  39
  40         /**
  41          * Check if the timer is running.
  42          * @return true if running, false if stopped.
  43          */
  44         bool isRunning() const;
  45
  46         /**
  47          * Set whether the timer is running.
  48          * @param running true to start the timer, false to stop it.
  49          */
  50         void setRunning(bool running);
  51
  52         /**
  53          * Reset the timer to zero.
  54          */
  55         void reset();
  56
  57         /**
  58          * Return the timer's count in seconds.
  59          *
  60          */
  61         //@{
  62         double count();
  63         double count() const;
  64         //@}
  65
  66         /**
  67          * Return a rough string representation of this object.
  68          */
  69         std::string repr() const;
  70
  71 private:
  72         bool running;
  73         time_t prev_time;
  74         time_t prev_count;
  75 };
  76
  77 void exportTimer();
  78
  79 #endif
  80