diff --git a/utility/include/system_timing.hpp b/utility/include/system_timing.hpp index a5d1ca50..5c53b66e 100644 --- a/utility/include/system_timing.hpp +++ b/utility/include/system_timing.hpp @@ -1,25 +1,34 @@ +//================================================================================================ +/// @file system_timing.cpp +/// +/// @brief Utility class for getting system time and handling u32 time rollover +/// @author Adrian Del Grosso +/// +/// @copyright 2022 Adrian Del Grosso +//================================================================================================ + #include namespace isobus { -class SystemTiming -{ -public: - static std::uint32_t get_timestamp_ms(); - static std::uint64_t get_timestamp_us(); + class SystemTiming + { + public: + static std::uint32_t get_timestamp_ms(); + static std::uint64_t get_timestamp_us(); - static std::uint32_t get_time_elapsed_ms(std::uint32_t timestamp_ms); - static std::uint64_t get_time_elapsed_us(std::uint64_t timestamp_us); + static std::uint32_t get_time_elapsed_ms(std::uint32_t timestamp_ms); + static std::uint64_t get_time_elapsed_us(std::uint64_t timestamp_us); - static bool time_expired_ms(std::uint32_t timestamp_ms, std::uint32_t timeout_ms); - static bool time_expired_us(std::uint64_t timestamp_us, std::uint64_t timeout_us); + static bool time_expired_ms(std::uint32_t timestamp_ms, std::uint32_t timeout_ms); + static bool time_expired_us(std::uint64_t timestamp_us, std::uint64_t timeout_us); -private: - static std::uint32_t incrementing_difference(std::uint32_t currentValue, std::uint32_t previousValue); - static std::uint64_t incrementing_difference(std::uint64_t currentValue, std::uint64_t previousValue); - static std::uint64_t s_timestamp_ms; - static std::uint64_t s_timestamp_us; -}; + private: + static std::uint32_t incrementing_difference(std::uint32_t currentValue, std::uint32_t previousValue); + static std::uint64_t incrementing_difference(std::uint64_t currentValue, std::uint64_t previousValue); + static std::uint64_t s_timestamp_ms; + static std::uint64_t s_timestamp_us; + }; } // namespace isobus diff --git a/utility/src/system_timing.cpp b/utility/src/system_timing.cpp index 15f5d6a0..228a4432 100644 --- a/utility/src/system_timing.cpp +++ b/utility/src/system_timing.cpp @@ -1,3 +1,12 @@ +//================================================================================================ +/// @file system_timing.cpp +/// +/// @brief Utility class for getting system time and handling u32 time rollover +/// @author Adrian Del Grosso +/// +/// @copyright 2022 Adrian Del Grosso +//================================================================================================ + #include "system_timing.hpp" #include