Timer.hpp

Go to the documentation of this file.

#ifndef PACEMAKER_TIMER_TIMER_HPP_
#define PACEMAKER_TIMER_TIMER_HPP_
 
#include <cassert>
#include <chrono>
#include <functional>
#include <memory>
 
#include "pacemaker/timer/pacemaker.timer_export.h"
 
namespace pacemaker::timer
{
  class Timer
  {
  public:
    PACEMAKER_TIMER_EXPORT Timer(const std::chrono::milliseconds &period, const std::size_t &tasks_to_execute);
    Timer(const Timer &) = delete;
    Timer(Timer &&) = delete;
    Timer &operator=(const Timer &) = delete;
    Timer &operator=(Timer &&) = delete;
 
    PACEMAKER_TIMER_EXPORT ~Timer();
 
    auto PACEMAKER_TIMER_EXPORT start(const std::function<void(void)> &StartFcn = []() {}) -> void;
 
    auto PACEMAKER_TIMER_EXPORT stop(const std::function<void(void)> &StopFcn = []() {}) -> void;
 
    template<class F>
    auto wait(const F &TimerFcn) -> void;
 
    [[nodiscard]] auto PACEMAKER_TIMER_EXPORT is_running() const -> bool;
 
  private:
    auto PACEMAKER_TIMER_EXPORT wait_for_single_object() -> void;
    auto PACEMAKER_TIMER_EXPORT set_thread_opts() -> void;
    auto PACEMAKER_TIMER_EXPORT revert_thread_opts() -> void;
 
    struct Impl;
    std::unique_ptr<Impl> pimpl;
 
    std::size_t m_tasksToExecute{};
  };
 
  template<class F>
  inline auto Timer::wait(const F &TimerFcn) -> void
  {
    assert(this->is_running() && "Timer was not started correctly. Did you forget a Timer::start?");
 
    this->set_thread_opts();
    TimerFcn(0); // Warm up the cache
    for (std::size_t i{}; i < this->m_tasksToExecute; ++i)
    {
      this->wait_for_single_object();
      TimerFcn(i);
    }
    this->wait_for_single_object(); // Do not skip last frame
    this->revert_thread_opts();
  }
} // namespace pacemaker::timer
#endif // PACEMAKER_TIMER_TIMER_HPP_