1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.StopWatch:
==========================================================================================================================================
|phoenix_title| **wx.StopWatch**
==========================================================================================================================================
The :ref:`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 <http://support.microsoft.com/?id=896256>`_ could be necessary.
.. seealso:: :ref:`wx.Timer`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>StopWatch</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.StopWatch_inheritance.png" alt="Inheritance diagram of StopWatch" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.StopWatch.html" title="wx.StopWatch" alt="" coords="5,5,115,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.StopWatch.__init__` Constructor.
:meth:`~wx.StopWatch.Pause` Pauses the stop watch.
:meth:`~wx.StopWatch.Resume` Resumes the stop watch which had been paused with :meth:`~StopWatch.Pause` .
:meth:`~wx.StopWatch.Start` (Re)starts the stop watch with a given initial value.
:meth:`~wx.StopWatch.Time` Returns the time in milliseconds since the start (or restart) or the last call of :meth:`~StopWatch.Pause` .
:meth:`~wx.StopWatch.TimeInMicro` Returns elapsed time in microseconds.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.StopWatch(object)
**Possible constructors**::
StopWatch()
The StopWatch class allow you to measure time intervals.
.. method:: __init__(self)
Constructor.
This starts the stop watch.
.. method:: Pause(self)
Pauses the stop watch.
Call :meth:`Resume` to resume time measuring again.
If this method is called several times, :meth:`Resume` must be called the same number of times to really resume the stop watch. You may, however, call :meth:`Start` to resume it unconditionally.
.. method:: Resume(self)
Resumes the stop watch which had been paused with :meth:`Pause` .
.. method:: Start(self, milliseconds=0)
(Re)starts the stop watch with a given initial value.
The stopwatch will always be running after calling :meth:`Start` , even if :meth:`Pause` had been called before and even if it had been called multiple times.
:param `milliseconds`:
:type `milliseconds`: long
.. method:: Time(self)
Returns the time in milliseconds since the start (or restart) or the last call of :meth:`Pause` .
:rtype: `long`
.. seealso:: :meth:`TimeInMicro`
.. method:: TimeInMicro(self)
Returns elapsed time in microseconds.
This method is similar to :meth:`Time` but returns the elapsed time in microseconds and not milliseconds. Notice that not all platforms really can measure times with this precision.
:rtype: `long`
.. versionadded:: 2.9.3
|
