coal::Timer Struct Reference

This class mimics the way "boost/timer/timer.hpp" operates while using the modern std::chrono library. Importantly, this class will only have an effect for C++11 and more. More...

#include <coal/timings.h>

Collaboration diagram for coal::Timer:

Public Types
typedef std::chrono::steady_clock	clock_type
typedef clock_type::duration	duration_type

Public Member Functions
	Timer (const bool start_on_construction=true)
	Default constructor for the timer. More...
CPUTimes	elapsed () const
duration_type	duration () const
void	start ()
void	stop ()
void	resume ()
bool	is_stopped () const

Protected Attributes
CPUTimes	m_times
bool	m_is_stopped
std::chrono::time_point< std::chrono::steady_clock >	m_start
std::chrono::time_point< std::chrono::steady_clock >	m_end

Detailed Description

This class mimics the way "boost/timer/timer.hpp" operates while using the modern std::chrono library. Importantly, this class will only have an effect for C++11 and more.

Member Typedef Documentation

clock_type

typedef std::chrono::steady_clock coal::Timer::clock_type

duration_type

typedef clock_type::duration coal::Timer::duration_type

Constructor & Destructor Documentation

Timer()

coal::Timer::Timer ( const bool  start_on_construction = true )

inline

Default constructor for the timer.

Parameters

[in]

start_on_construction

if true, the timer will be run just after the object is created

Member Function Documentation

duration()

duration_type coal::Timer::duration ( ) const

inline

elapsed()

CPUTimes coal::Timer::elapsed ( ) const

inline

is_stopped()

bool coal::Timer::is_stopped ( ) const

inline

resume()

void coal::Timer::resume ( )

inline

start()

void coal::Timer::start ( )

inline

stop()

void coal::Timer::stop ( )

inline

Member Data Documentation

m_end

std::chrono::time_point<std::chrono::steady_clock> coal::Timer::m_end

protected

m_is_stopped

bool coal::Timer::m_is_stopped

protected

m_start

std::chrono::time_point<std::chrono::steady_clock> coal::Timer::m_start

protected

m_times

CPUTimes coal::Timer::m_times

protected

---

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

• include/coal/timings.h