lucid::TimerGuard< T > Class Template Reference

The TimeGuard wraps a timer object and pauses it when the guard object is destructed. More...

#include <Timer.h>

Public Member Functions
	TimerGuard (T *timer, bool start_timer=true)
	Construct a new TimeGuard object.
	~TimerGuard ()
	When the timer guard object is destructed, it pauses the embedded timer object.
void	pause ()
	Pause the guarded timer object if the timer is not a nullptr.
void	resume ()
	Resume the guarded timer object if the timer is not a nullptr.

Private Attributes
T *const	timer_
	The timer to be guarded.

Detailed Description

template<IsAnyOf< Timer, UserTimer > T>
class lucid::TimerGuard< T >

The TimeGuard wraps a timer object and pauses it when the guard object is destructed.

Useful for measuring the exact time spent in a block of code.

// Example usage
class MyClass {
 private:
  Timer timer_;
 public:
  void function_to_measure() {
   TimerGuard guard(&timer_, true);
   // Code to measure
  }
  // Return the total time elapsed, even across multiple calls
  double time_elapsed() { return timer_.seconds(); }
};

Constructor & Destructor Documentation

TimerGuard()

template<IsAnyOf< Timer, UserTimer > T>

lucid::TimerGuard< T >::TimerGuard ( T * timer, bool start_timer = true )

explicit

Construct a new TimeGuard object.

If timer is a nullptr, the guard will not do anything. If start_timer is true, the timer starts as soon as the guard is constructed. Otherwise, the method resume has to be called manually to start the timer.

Parameters

timer	a pointer to the timer object to be guarded. Must remain valid for the lifetime of the guard
start_timer	whether the timer should be started as soon as the guard is created

~TimerGuard()

template<IsAnyOf< Timer, UserTimer > T>

lucid::TimerGuard< T >::~TimerGuard

(

)

When the timer guard object is destructed, it pauses the embedded timer object.

If the timer is a nullptr, this does nothing.

---

The documentation for this class was generated from the following files:

• lucid/util/Timer.h
• lucid/util/Timer.cpp