blob: d94d1362ee94c176ff2b444f0b978c38d026b47c (
plain)
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
|
#ifndef _GLIBMM_TIMER_H
#define _GLIBMM_TIMER_H
/* timer.h
*
* Copyright (C) 2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <glibmmconfig.h>
extern "C" {
using GTimer = struct _GTimer;
}
namespace Glib
{
/** Portable stop watch interface.
* This resembles a convenient and portable timer with microseconds resolution.
*/
class GLIBMM_API Timer
{
public:
/** Create a new timer.
* Also starts timing by calling start() implicitly.
*/
Timer();
~Timer() noexcept;
// not copyable
Timer(const Timer&) = delete;
Timer& operator=(const Timer&) = delete;
void start();
void stop();
void reset();
// Can't call it Timer::continue(). continue is a keyword in C and C++.
/** Resumes a timer that has previously been stopped with stop().
* stop() must be called before using this function.
*
* @newin{2,70]
*/
void resume();
/** Get the elapsed time.
* @return The value in seconds.
*/
double elapsed() const;
/** Get the elapsed time.
* @return The value in seconds. Also fills @p microseconds
* with the corresponding @htmlonlyµs@endhtmlonly value.
*/
double elapsed(unsigned long& microseconds) const;
/** Exposes whether the timer is currently active.
*
* @newin{2,70]
* @return <tt>true</tt> if the timer is running, <tt>false</tt> otherwise.
*/
bool is_active() const;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
GTimer* gobj() { return gobject_; }
const GTimer* gobj() const { return gobject_; }
#endif
private:
GTimer* gobject_;
};
/// Pauses the current thread for the given number of microseconds.
GLIBMM_API
void usleep(unsigned long microseconds);
} // namespace Glib
#endif /* _GLIBMM_TIMER_H */
|
