ElapsedTimer.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: MIT
#pragma once
#ifndef TIME_SHIELD_HEADER_TIMERS_ELAPSEDTIMER_HPP_INCLUDED
#define TIME_SHIELD_HEADER_TIMERS_ELAPSEDTIMER_HPP_INCLUDED
 
 
#include <time_shield/core.hpp>
 
#include <chrono>
#include <cstdint>
 
namespace time_shield {
 
    class ElapsedTimer {
    public:
        using clock = std::chrono::steady_clock;
        using duration = clock::duration;
        using time_point = clock::time_point;
 
        ElapsedTimer() noexcept = default;
 
        explicit ElapsedTimer(bool start_immediately) noexcept {
            if (start_immediately) {
                start();
            }
        }
 
        void start() noexcept {
            m_start_time = clock::now();
            m_is_running = true;
        }
 
        TIME_SHIELD_NODISCARD duration restart() noexcept {
            const time_point now = clock::now();
            const duration delta = m_is_running ? now - m_start_time : duration::zero();
            m_start_time = now;
            m_is_running = true;
            return delta;
        }
 
        TIME_SHIELD_NODISCARD ts_ms_t restart_ms(ts_ms_t now_ms) noexcept {
            const duration since_epoch = std::chrono::duration_cast<duration>(std::chrono::milliseconds(now_ms));
            const time_point now(since_epoch);
            const duration delta = m_is_running ? now - m_start_time : duration::zero();
            m_start_time = now;
            m_is_running = true;
            return std::chrono::duration_cast<std::chrono::milliseconds>(delta).count();
        }
 
        TIME_SHIELD_NODISCARD ts_t restart_sec(ts_t now_sec) noexcept {
            const duration since_epoch = std::chrono::duration_cast<duration>(std::chrono::seconds(now_sec));
            const time_point now(since_epoch);
            const duration delta = m_is_running ? now - m_start_time : duration::zero();
            m_start_time = now;
            m_is_running = true;
            return std::chrono::duration_cast<std::chrono::seconds>(delta).count();
        }
 
        void invalidate() noexcept {
            m_is_running = false;
        }
 
        TIME_SHIELD_NODISCARD bool is_running() const noexcept {
            return m_is_running;
        }
 
        TIME_SHIELD_NODISCARD bool is_valid() const noexcept {
            return m_is_running;
        }
 
        TIME_SHIELD_NODISCARD time_point start_time() const noexcept {
            return m_start_time;
        }
 
        TIME_SHIELD_NODISCARD duration elapsed() const noexcept {
            return elapsed(clock::now());
        }
 
        TIME_SHIELD_NODISCARD duration elapsed(time_point now) const noexcept {
            if (!m_is_running) {
                return duration::zero();
            }
            return now - m_start_time;
        }
 
        TIME_SHIELD_NODISCARD std::int64_t elapsed_ns() const noexcept {
            return elapsed_count<std::chrono::nanoseconds>();
        }
 
        TIME_SHIELD_NODISCARD std::int64_t elapsed_ns(std::int64_t now_ns) const noexcept {
            const duration since_epoch = std::chrono::duration_cast<duration>(std::chrono::nanoseconds(now_ns));
            const time_point now(since_epoch);
            return std::chrono::duration_cast<std::chrono::nanoseconds>(elapsed(now)).count();
        }
 
        TIME_SHIELD_NODISCARD ts_ms_t elapsed_ms() const noexcept {
            return elapsed_count<std::chrono::milliseconds>();
        }
 
        TIME_SHIELD_NODISCARD ts_ms_t elapsed_ms(ts_ms_t now_ms) const noexcept {
            const duration since_epoch = std::chrono::duration_cast<duration>(std::chrono::milliseconds(now_ms));
            const time_point now(since_epoch);
            return std::chrono::duration_cast<std::chrono::milliseconds>(elapsed(now)).count();
        }
 
        TIME_SHIELD_NODISCARD ts_t elapsed_sec() const noexcept {
            return elapsed_count<std::chrono::seconds>();
        }
 
        TIME_SHIELD_NODISCARD ts_t elapsed_sec(ts_t now_sec) const noexcept {
            const duration since_epoch = std::chrono::duration_cast<duration>(std::chrono::seconds(now_sec));
            const time_point now(since_epoch);
            return std::chrono::duration_cast<std::chrono::seconds>(elapsed(now)).count();
        }
 
        template <class Duration>
        TIME_SHIELD_NODISCARD typename Duration::rep elapsed_count() const noexcept {
            return std::chrono::duration_cast<Duration>(elapsed()).count();
        }
 
        TIME_SHIELD_NODISCARD bool has_expired(ts_ms_t timeout_ms) const noexcept {
            if (!m_is_running) {
                return false;
            }
            if (timeout_ms <= 0) {
                return true;
            }
            return elapsed_ms() >= timeout_ms;
        }
 
        TIME_SHIELD_NODISCARD bool has_expired_sec(ts_t timeout_sec) const noexcept {
            if (!m_is_running) {
                return false;
            }
            if (timeout_sec <= 0) {
                return true;
            }
            return elapsed() >= std::chrono::seconds(timeout_sec);
        }
 
        TIME_SHIELD_NODISCARD std::int64_t ms_since_reference() const noexcept {
            if (!m_is_running) {
                return 0;
            }
            return std::chrono::duration_cast<std::chrono::milliseconds>(m_start_time.time_since_epoch()).count();
        }
 
    private:
        time_point m_start_time{};
        bool m_is_running{false};
    };
 
} // namespace time_shield
 
#endif // TIME_SHIELD_HEADER_TIMERS_ELAPSEDTIMER_HPP_INCLUDED