IntervalTimer.h

Go to the documentation of this file.

#pragma once
 
#include <misc/gen/TimeSpec.h>
#include <misc/global.h>
 
namespace sf
{
class _MISC_CLASS IntervalTimer
{
  public:
    IntervalTimer() = default;
 
    explicit inline IntervalTimer(const timespec& t);
 
    explicit IntervalTimer(int usec);
 
    explicit IntervalTimer(double sec);
 
    void set(const timespec& t);
 
    [[nodiscard]] bool active() const;
 
    [[nodiscard]] bool active(const timespec& t) const;
 
    inline void enable();
 
    inline void disable();
 
    [[nodiscard]] inline bool isEnabled() const;
 
    [[nodiscard]] inline const TimeSpec& getInterval() const;
    [[nodiscard]] inline const TimeSpec& getTarget() const;
 
    [[nodiscard]] TimeSpec getTimeLeft() const;
 
    [[nodiscard]] TimeSpec getTimeLeft(const timespec& t) const;
 
    [[nodiscard]] TimeSpec getTimeOver() const;
 
    [[nodiscard]] TimeSpec getTimeOver(const timespec& t) const;
 
    explicit inline operator bool() const;
 
    inline bool operator()(const timespec& t) const;
 
  private:
    TimeSpec _interval{0, 0};
    TimeSpec _target{0, 0};
    bool _enabled{false};
};
 
inline IntervalTimer::IntervalTimer(const timespec& t)
{
  set(t);
}
 
inline void IntervalTimer::enable()
{
  _enabled = true;
}
 
inline void IntervalTimer::disable()
{
  _enabled = false;
}
 
inline bool IntervalTimer::isEnabled() const
{
  return _enabled;
}
 
inline const TimeSpec& IntervalTimer::getInterval() const
{
  return _interval;
}
 
inline const TimeSpec& IntervalTimer::getTarget() const
{
  return _target;
}
 
inline IntervalTimer::operator bool() const
{
  return active();
}
 
inline bool IntervalTimer::operator()(const timespec& t) const
{
  return active(t);
}
 
}// namespace sf