flow::Timer< ClockType > Class Template Reference

A simple timer to record timelapses. Uses steady_clock by default. More...

#include <flow_timer.h>

Public Member Functions
constexpr	Timer (std::size_t reserveSize=8)
	Constructs a Timer and reserves space for time points.
constexpr std::size_t	size () const
	Returns the number of recorded time points.
void	reset ()
	Clears all recorded time points and resets the starting time.
void	record ()
	Records the current time point relative to the last reset.
std::string	toString () const
	Formats and returns a string showing all recorded durations since reset.

Private Types
using	TimePoint = typename ClockType::time_point

Private Attributes
TimePoint	begin_ {}
std::vector< TimePoint >	timepoints_ {}

Detailed Description

template<typename ClockType = std::chrono::steady_clock>
class flow::Timer< ClockType >

A simple timer to record timelapses. Uses steady_clock by default.

Definition at line 11 of file flow_timer.h.

Member Typedef Documentation

TimePoint

template<typename ClockType = std::chrono::steady_clock>

using flow::Timer< ClockType >::TimePoint = typename ClockType::time_point

private

Definition at line 12 of file flow_timer.h.

Constructor & Destructor Documentation

Timer()

template<typename ClockType = std::chrono::steady_clock>

flow::Timer< ClockType >::Timer ( std::size_t reserveSize = 8 )

inlineexplicitconstexpr

Constructs a Timer and reserves space for time points.

Parameters

reserveSize

Number of time points to reserve space for.

Definition at line 19 of file flow_timer.h.

                                                        {
      timepoints_.reserve(reserveSize);
    }

References timepoints_.

Member Function Documentation

record()

template<typename ClockType = std::chrono::steady_clock>

void flow::Timer< ClockType >::record ( )

inline

Records the current time point relative to the last reset.

Definition at line 36 of file flow_timer.h.

                  {
      timepoints_.push_back(ClockType::now());
    }

References timepoints_.

reset()

template<typename ClockType = std::chrono::steady_clock>

void flow::Timer< ClockType >::reset ( )

inline

Clears all recorded time points and resets the starting time.

Definition at line 30 of file flow_timer.h.

                 {
      timepoints_.clear();
      begin_ = ClockType::now();
    }

References begin_, and timepoints_.

size()

template<typename ClockType = std::chrono::steady_clock>

std::size_t flow::Timer< ClockType >::size ( ) const

inlineconstexpr

Returns the number of recorded time points.

Returns

Count of recorded time points.

Definition at line 25 of file flow_timer.h.

                                     {
      return timepoints_.size();
    }

References timepoints_.

toString()

template<typename ClockType = std::chrono::steady_clock>

std::string flow::Timer< ClockType >::toString ( ) const

inline

Formats and returns a string showing all recorded durations since reset.

Returns

Formatted string of all recorded time intervals.

Definition at line 42 of file flow_timer.h.

                               {
      std::string str = std::format("Total record entries: {}\n", timepoints_.size());
      std::size_t i = 0;
      for (const auto& timepoint : timepoints_) {
        auto dur = timepoint - begin_;
        str += std::format("\t[{}] {}, {}, {}\n",
                           i,
                           std::chrono::duration_cast<std::chrono::seconds>(dur),
                           std::chrono::duration_cast<std::chrono::milliseconds>(dur),
                           std::chrono::duration_cast<std::chrono::microseconds>(dur));
        ++i;
      }
      return str;
    }

References begin_, and timepoints_.

Member Data Documentation

begin_

template<typename ClockType = std::chrono::steady_clock>

TimePoint flow::Timer< ClockType >::begin_ {}

private

Definition at line 13 of file flow_timer.h.

{};

Referenced by reset(), and toString().

timepoints_

template<typename ClockType = std::chrono::steady_clock>

std::vector<TimePoint> flow::Timer< ClockType >::timepoints_ {}

private

Definition at line 14 of file flow_timer.h.

{};

Referenced by record(), reset(), size(), Timer(), and toString().

---

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

• flow_timer.h