Public Member Functions | Protected Attributes | List of all members
hpp::fcl::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 <timings.h>

Public Member Functions

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

Protected Attributes

bool m_is_stopped
 
CPUTimes m_times
 

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.

Definition at line 32 of file timings.h.

Constructor & Destructor Documentation

◆ Timer()

hpp::fcl::Timer::Timer ( const bool  start_on_construction = true)
inline

Default constructor for the timer.

Parameters
[in]start_on_constructionif true, the timer will be run just after the object is created

Definition at line 42 of file timings.h.

Member Function Documentation

◆ elapsed()

CPUTimes hpp::fcl::Timer::elapsed ( ) const
inline

Definition at line 46 of file timings.h.

◆ is_stopped()

bool hpp::fcl::Timer::is_stopped ( ) const
inline

Definition at line 100 of file timings.h.

◆ resume()

void hpp::fcl::Timer::resume ( )
inline

Definition at line 91 of file timings.h.

◆ start()

void hpp::fcl::Timer::start ( )
inline

Definition at line 66 of file timings.h.

◆ stop()

void hpp::fcl::Timer::stop ( )
inline

Definition at line 77 of file timings.h.

Member Data Documentation

◆ m_is_stopped

bool hpp::fcl::Timer::m_is_stopped
protected

Definition at line 104 of file timings.h.

◆ m_times

CPUTimes hpp::fcl::Timer::m_times
protected

Definition at line 103 of file timings.h.


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


hpp-fcl
Author(s):
autogenerated on Fri Aug 2 2024 02:45:17