Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
cartographer::common::RateTimer< ClockType > Class Template Reference

#include <rate_timer.h>

Classes

struct  Event
 

Public Member Functions

double ComputeRate () const
 
double ComputeWallTimeRateRatio () const
 
std::string DebugString () const
 
RateTimeroperator= (const RateTimer &)=delete
 
void Pulse (common::Time time)
 
 RateTimer (const common::Duration window_duration)
 
 RateTimer (const RateTimer &)=delete
 
 ~RateTimer ()
 

Private Member Functions

std::vector< double > ComputeDeltasInSeconds () const
 
std::string DeltasDebugString () const
 

Private Attributes

std::deque< Eventevents_
 
const common::Duration window_duration_
 

Detailed Description

template<typename ClockType = std::chrono::steady_clock>
class cartographer::common::RateTimer< ClockType >

Definition at line 37 of file rate_timer.h.

Constructor & Destructor Documentation

◆ RateTimer() [1/2]

template<typename ClockType = std::chrono::steady_clock>
cartographer::common::RateTimer< ClockType >::RateTimer ( const common::Duration  window_duration)
inlineexplicit

Definition at line 41 of file rate_timer.h.

◆ ~RateTimer()

template<typename ClockType = std::chrono::steady_clock>
cartographer::common::RateTimer< ClockType >::~RateTimer ( )
inline

Definition at line 43 of file rate_timer.h.

◆ RateTimer() [2/2]

template<typename ClockType = std::chrono::steady_clock>
cartographer::common::RateTimer< ClockType >::RateTimer ( const RateTimer< ClockType > &  )
delete

Member Function Documentation

◆ ComputeDeltasInSeconds()

template<typename ClockType = std::chrono::steady_clock>
std::vector<double> cartographer::common::RateTimer< ClockType >::ComputeDeltasInSeconds ( ) const
inlineprivate

Definition at line 99 of file rate_timer.h.

◆ ComputeRate()

template<typename ClockType = std::chrono::steady_clock>
double cartographer::common::RateTimer< ClockType >::ComputeRate ( ) const
inline

Definition at line 49 of file rate_timer.h.

◆ ComputeWallTimeRateRatio()

template<typename ClockType = std::chrono::steady_clock>
double cartographer::common::RateTimer< ClockType >::ComputeWallTimeRateRatio ( ) const
inline

Definition at line 60 of file rate_timer.h.

◆ DebugString()

template<typename ClockType = std::chrono::steady_clock>
std::string cartographer::common::RateTimer< ClockType >::DebugString ( ) const
inline

Definition at line 81 of file rate_timer.h.

◆ DeltasDebugString()

template<typename ClockType = std::chrono::steady_clock>
std::string cartographer::common::RateTimer< ClockType >::DeltasDebugString ( ) const
inlineprivate

Definition at line 112 of file rate_timer.h.

◆ operator=()

template<typename ClockType = std::chrono::steady_clock>
RateTimer& cartographer::common::RateTimer< ClockType >::operator= ( const RateTimer< ClockType > &  )
delete

◆ Pulse()

template<typename ClockType = std::chrono::steady_clock>
void cartographer::common::RateTimer< ClockType >::Pulse ( common::Time  time)
inline

Definition at line 71 of file rate_timer.h.

Member Data Documentation

◆ events_

template<typename ClockType = std::chrono::steady_clock>
std::deque<Event> cartographer::common::RateTimer< ClockType >::events_
private

Definition at line 129 of file rate_timer.h.

◆ window_duration_

template<typename ClockType = std::chrono::steady_clock>
const common::Duration cartographer::common::RateTimer< ClockType >::window_duration_
private

Definition at line 130 of file rate_timer.h.


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


cartographer
Author(s): The Cartographer Authors
autogenerated on Mon Feb 28 2022 22:00:59