summaryrefslogtreecommitdiff
path: root/src/common/time.hpp
blob: 8efbd28bf384f63b83b774238e6261737954aa84 (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
#pragma once

#include <stdint.h>

constexpr double MICROS_TO_SECS = 0.000001;
constexpr double MICROS_TO_MILLIS = 0.001;

namespace common
{

	/**
	 * A representation of time.
	 */
	class Time
	{
	public:
		/**
		 * A representation of time.
		 *
		 * @param time_micros Time in microseconds
		 */
		explicit Time(uint64_t time_micros);

		/**
		 * Updates the time to the current time.
		 */
		void update();

		/**
		 * Returns the difference between two points in time.
		 *
		 * @param prev_time A previous point in time
		 */
		Time diff(Time prev_time) const;

		/**
		 * Returns the time in seconds.
		 */
		double secs() const;

		/**
		 * Returns the time in milliseconds.
		 */
		double millisecs() const;

		/**
		 * Returns the time in microseconds.
		 */
		uint64_t microsecs() const;

	private:
		uint64_t _time_micros;
	};

	/**
	 * Returns a time object for the time since the program started.
	 */
	Time time_now();

} // namespace common