wx.StopWatch

The wx.StopWatch class allow you to measure time intervals.

For example, you may use it to measure the time elapsed by some function:

sw = wx.StopWatch()
CallLongRunningFunction()
wx.LogMessage("The long running function took %dms to execute", sw.Time())
sw.Pause()

# stopwatch is stopped now ...
sw.Resume()
CallLongRunningFunction()
wx.LogMessage("And calling it twice took %dms in all", sw.Time())

Since wxWidgets 2.9.3 this class uses QueryPerformanceCounter() function under MSW to measure the elapsed time. It provides higher precision than the usual timer functions but can suffer from bugs in its implementation in some Windows XP versions. If you encounter such problems, installing a Microsoft hot fix from http://support.microsoft.com/?id=896256 could be necessary.

See also

wx.Timer

Class Hierarchy

Inheritance diagram for class StopWatch:

Methods Summary

__init__	Constructor.
Pause	Pauses the stop watch.
Resume	Resumes the stop watch which had been paused with Pause .
Start	(Re)starts the stop watch with a given initial value.
Time	Returns the time in milliseconds since the start (or restart) or the last call of Pause .
TimeInMicro	Returns elapsed time in microseconds.

Class API

class wx.StopWatch(object)

Possible constructors:

StopWatch() -> None

The StopWatch class allow you to measure time intervals.

Methods

__init__(self)

Constructor.

This starts the stop watch.

Return type:

None

---

Pause(self)

Pauses the stop watch.

Call Resume to resume time measuring again.

If this method is called several times, Resume must be called the same number of times to really resume the stop watch. You may, however, call Start to resume it unconditionally.

Return type:

None

---

Resume(self)

Resumes the stop watch which had been paused with Pause .

Return type:

None

---

Start(self, milliseconds=0)

(Re)starts the stop watch with a given initial value.

The stopwatch will always be running after calling Start , even if Pause had been called before and even if it had been called multiple times.

Parameters:

milliseconds (long)

Return type:

None

---

Time(self)

Returns the time in milliseconds since the start (or restart) or the last call of Pause .

Return type:

int

See also

TimeInMicro

---

TimeInMicro(self)

Returns elapsed time in microseconds.

This method is similar to Time but returns the elapsed time in microseconds and not milliseconds. Notice that not all platforms really can measure times with this precision.

Return type:

int

Added in version 2.9.3.