aboutsummaryrefslogtreecommitdiffstats
path: root/include/distortos/TickClock.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'include/distortos/TickClock.hpp')
-rw-r--r--include/distortos/TickClock.hpp56
1 files changed, 56 insertions, 0 deletions
diff --git a/include/distortos/TickClock.hpp b/include/distortos/TickClock.hpp
new file mode 100644
index 0000000..7f1ace0
--- /dev/null
+++ b/include/distortos/TickClock.hpp
@@ -0,0 +1,56 @@
+/**
+ * \file
+ * \brief TickClock class header
+ *
+ * \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info
+ *
+ * \par License
+ * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not
+ * distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#ifndef INCLUDE_DISTORTOS_TICKCLOCK_HPP_
+#define INCLUDE_DISTORTOS_TICKCLOCK_HPP_
+
+#include "distortos/distortosConfiguration.h"
+
+#include <chrono>
+
+namespace distortos
+{
+
+/**
+ * \brief TickClock is a std::chrono clock, equivalent of std::chrono::steady_clock
+ *
+ * \ingroup clocks
+ */
+
+class TickClock
+{
+public:
+
+ /// type of tick counter
+ using rep = uint64_t;
+
+ /// std::ratio type representing the tick period of the clock, in seconds
+ using period = std::ratio<1, CONFIG_TICK_FREQUENCY>;
+
+ /// basic duration type of clock
+ using duration = std::chrono::duration<rep, period>;
+
+ /// basic time_point type of clock
+ using time_point = std::chrono::time_point<TickClock>;
+
+ /**
+ * \return time_point representing the current value of the clock
+ */
+
+ static time_point now();
+
+ /// this is a steady clock - it cannot be adjusted
+ static constexpr bool is_steady {true};
+};
+
+} // namespace distortos
+
+#endif // INCLUDE_DISTORTOS_TICKCLOCK_HPP_