2011-03-20 12:05:19 -06:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: wx/stopwatch.h
|
|
|
|
// Purpose: wxStopWatch and global time-related functions
|
2012-03-17 19:12:27 -06:00
|
|
|
// Author: Julian Smart (wxTimer), Sylvain Bougnoux (wxStopWatch),
|
|
|
|
// Vadim Zeitlin (time functions, current wxStopWatch)
|
2011-03-20 12:05:19 -06:00
|
|
|
// Created: 26.06.03 (extracted from wx/timer.h)
|
2012-03-17 19:12:27 -06:00
|
|
|
// RCS-ID: $Id: stopwatch.h 69838 2011-11-27 19:50:27Z VZ $
|
2011-03-20 12:05:19 -06:00
|
|
|
// Copyright: (c) 1998-2003 Julian Smart, Sylvain Bougnoux
|
2012-03-17 19:12:27 -06:00
|
|
|
// (c) 2011 Vadim Zeitlin
|
2011-03-20 12:05:19 -06:00
|
|
|
// Licence: wxWindows licence
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
#ifndef _WX_STOPWATCH_H_
|
|
|
|
#define _WX_STOPWATCH_H_
|
|
|
|
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#include "wx/longlong.h"
|
|
|
|
|
2012-03-17 19:12:27 -06:00
|
|
|
// Time-related functions are also available via this header for compatibility
|
|
|
|
// but you should include wx/time.h directly if you need only them and not
|
|
|
|
// wxStopWatch itself.
|
|
|
|
#include "wx/time.h"
|
|
|
|
|
2011-03-20 12:05:19 -06:00
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxStopWatch: measure time intervals with up to 1ms resolution
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
|
|
|
#if wxUSE_STOPWATCH
|
|
|
|
|
|
|
|
class WXDLLIMPEXP_BASE wxStopWatch
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
// ctor starts the stop watch
|
|
|
|
wxStopWatch() { m_pauseCount = 0; Start(); }
|
|
|
|
|
2012-03-17 19:12:27 -06:00
|
|
|
// Start the stop watch at the moment t0 expressed in milliseconds (i.e.
|
|
|
|
// calling Time() immediately afterwards returns t0). This can be used to
|
|
|
|
// restart an existing stopwatch.
|
2011-03-20 12:05:19 -06:00
|
|
|
void Start(long t0 = 0);
|
|
|
|
|
|
|
|
// pause the stop watch
|
|
|
|
void Pause()
|
|
|
|
{
|
|
|
|
if ( m_pauseCount++ == 0 )
|
2012-03-17 19:12:27 -06:00
|
|
|
m_elapsedBeforePause = GetCurrentClockValue() - m_t0;
|
2011-03-20 12:05:19 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
// resume it
|
|
|
|
void Resume()
|
|
|
|
{
|
|
|
|
wxASSERT_MSG( m_pauseCount > 0,
|
|
|
|
wxT("Resuming stop watch which is not paused") );
|
|
|
|
|
|
|
|
if ( --m_pauseCount == 0 )
|
2012-03-17 19:12:27 -06:00
|
|
|
{
|
|
|
|
DoStart();
|
|
|
|
m_t0 -= m_elapsedBeforePause;
|
|
|
|
}
|
2011-03-20 12:05:19 -06:00
|
|
|
}
|
|
|
|
|
2012-03-17 19:12:27 -06:00
|
|
|
// Get elapsed time since the last Start() in microseconds.
|
|
|
|
wxLongLong TimeInMicro() const;
|
2011-03-20 12:05:19 -06:00
|
|
|
|
2012-03-17 19:12:27 -06:00
|
|
|
// get elapsed time since the last Start() in milliseconds
|
|
|
|
long Time() const { return (TimeInMicro()/1000).ToLong(); }
|
2011-03-20 12:05:19 -06:00
|
|
|
|
|
|
|
private:
|
2012-03-17 19:12:27 -06:00
|
|
|
// Really starts the stop watch. The initial time is set to current clock
|
|
|
|
// value.
|
|
|
|
void DoStart();
|
|
|
|
|
|
|
|
// Returns the current clock value in its native units.
|
|
|
|
wxLongLong GetCurrentClockValue() const;
|
|
|
|
|
|
|
|
// Return the frequency of the clock used in its ticks per second.
|
|
|
|
wxLongLong GetClockFreq() const;
|
|
|
|
|
|
|
|
|
|
|
|
// The clock value when the stop watch was last started. Its units vary
|
|
|
|
// depending on the platform.
|
2011-03-20 12:05:19 -06:00
|
|
|
wxLongLong m_t0;
|
|
|
|
|
2012-03-17 19:12:27 -06:00
|
|
|
// The elapsed time as of last Pause() call (only valid if m_pauseCount >
|
|
|
|
// 0) in the same units as m_t0.
|
|
|
|
wxLongLong m_elapsedBeforePause;
|
2011-03-20 12:05:19 -06:00
|
|
|
|
|
|
|
// if > 0, the stop watch is paused, otherwise it is running
|
|
|
|
int m_pauseCount;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // wxUSE_STOPWATCH
|
|
|
|
|
|
|
|
#if wxUSE_LONGLONG && WXWIN_COMPATIBILITY_2_6
|
|
|
|
|
|
|
|
// Starts a global timer
|
|
|
|
// -- DEPRECATED: use wxStopWatch instead
|
|
|
|
wxDEPRECATED( void WXDLLIMPEXP_BASE wxStartTimer() );
|
|
|
|
|
|
|
|
// Gets elapsed milliseconds since last wxStartTimer or wxGetElapsedTime
|
|
|
|
// -- DEPRECATED: use wxStopWatch instead
|
|
|
|
wxDEPRECATED( long WXDLLIMPEXP_BASE wxGetElapsedTime(bool resetTimer = true) );
|
|
|
|
|
|
|
|
#endif // wxUSE_LONGLONG && WXWIN_COMPATIBILITY_2_6
|
|
|
|
|
|
|
|
#endif // _WX_STOPWATCH_H_
|