interface/wx/stopwatch.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        stopwatch.h
   3 // Purpose:     interface of wxStopWatch
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxStopWatch
  11
  12     The wxStopWatch class allow you to measure time intervals.
  13
  14     For example, you may use it to measure the time elapsed by some function:
  15
  16     @code
  17         wxStopWatch sw;
  18         CallLongRunningFunction();
  19         wxLogMessage("The long running function took %ldms to execute",
  20                      sw.Time());
  21         sw.Pause();
  22         ... stopwatch is stopped now ...
  23         sw.Resume();
  24         CallLongRunningFunction();
  25         wxLogMessage("And calling it twice took $ldms in all", sw.Time());
  26     @endcode
  27
  28     Since wxWidgets 2.9.3 this class uses @c ::QueryPerformanceCounter()
  29     function under MSW to measure the elapsed time. It provides higher
  30     precision than the usual timer functions but can suffer from bugs in its
  31     implementation in some Windows XP versions. If you encounter such problems,
  32     installing a Microsoft hot fix from http://support.microsoft.com/?id=896256
  33     could be necessary.
  34
  35     @library{wxbase}
  36     @category{misc}
  37
  38     @see wxTimer
  39 */
  40 class wxStopWatch
  41 {
  42 public:
  43     /**
  44         Constructor. This starts the stop watch.
  45     */
  46     wxStopWatch();
  47
  48     /**
  49         Pauses the stop watch. Call Resume() to resume time measuring again.
  50
  51         If this method is called several times, @c Resume() must be called the same
  52         number of times to really resume the stop watch. You may, however, call
  53         Start() to resume it unconditionally.
  54     */
  55     void Pause();
  56
  57     /**
  58         Resumes the stop watch which had been paused with Pause().
  59     */
  60     void Resume();
  61
  62     /**
  63         (Re)starts the stop watch with a given initial value.
  64     */
  65     void Start(long milliseconds = 0);
  66
  67     /**
  68         Returns the time in milliseconds since the start (or restart) or the last
  69         call of Pause().
  70     */
  71     long Time() const;
  72 };
  73
  74
  75
  76 // ============================================================================
  77 // Global functions/macros
  78 // ============================================================================
  79
  80 /** @addtogroup group_funcmacro_time */
  81 //@{
  82
  83 /**
  84     Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
  85
  86     @see wxDateTime::Now()
  87
  88     @header{wx/stopwatch.h}
  89 */
  90 long wxGetLocalTime();
  91
  92 /**
  93     Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
  94
  95     @see wxDateTime::Now(), wxLongLong
  96
  97     @header{wx/stopwatch.h}
  98 */
  99 wxLongLong wxGetLocalTimeMillis();
 100
 101 /**
 102     Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
 103
 104     @see wxDateTime::Now()
 105
 106     @header{wx/stopwatch.h}
 107 */
 108 long wxGetUTCTime();
 109
 110 //@}
 111