Project::OSiRiON - Git repositories
Project::OSiRiON
News . About . Screenshots . Downloads . Forum . Wiki . Tracker . Git
summaryrefslogtreecommitdiff
blob: 125363d3192bbd3bd9e547001b9f5ebf30df3e02 (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
/*
   sys/timer.h
   This file is part of the Osirion project and is distributed under
   the terms and conditions of the GNU General Public License version 2
*/

#ifndef __INCLUDED_SYS_TIMER_H__
#define __INCLUDED_SYS_TIMER_H__

namespace sys
{

/// a timer measures intervals in seconds
/*! A timer class measures the time elapsed
* between the last two calls to its mark() function.
*/
class Timer
{
public:
	/**
	 * @brief constructor
	 * The constructor autmaticly calls reset()
	 * */
	Timer();
	
	/**
	 * @brief destructor
	 * */
	~Timer();

	/**
	 * @brief reset the timer to 0
	 */
	void reset();

	/**
	 * @brief return the time elapsed since the last reset() call, in milliseconds
	 * 
	 * */
	unsigned long timestamp() const;

private:
	unsigned long			timer_start;

}; // class Timer

} // namespace sys

#endif // __INCLUDED_SYS_TIMER_H__