AceTime  1.0
Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.
Public Member Functions | List of all members
ace_time::common::TimingStats Class Reference

Helper class to collect timing statistics such as min, max, average. More...

#include <TimingStats.h>

Public Member Functions

 TimingStats ()
 Constructor. More...
 
void reset ()
 
uint16_t getMax () const
 
uint16_t getMin () const
 
uint16_t getAvg () const
 
uint16_t getExpDecayAvg () const
 An exponential decay average. More...
 
uint16_t getCount () const
 Number of times update() was called since last reset. More...
 
uint16_t getCounter () const
 Number of times update() was called from the beginning of time. More...
 
void update (uint16_t duration)
 

Detailed Description

Helper class to collect timing statistics such as min, max, average.

Definition at line 19 of file TimingStats.h.

Constructor & Destructor Documentation

◆ TimingStats()

ace_time::common::TimingStats::TimingStats ( )
inline

Constructor.

Default copy-constructor and assignment operator ok.

Definition at line 22 of file TimingStats.h.

Member Function Documentation

◆ getCount()

uint16_t ace_time::common::TimingStats::getCount ( ) const
inline

Number of times update() was called since last reset.

Definition at line 44 of file TimingStats.h.

◆ getCounter()

uint16_t ace_time::common::TimingStats::getCounter ( ) const
inline

Number of times update() was called from the beginning of time.

Never reset. This is useful to determining how many times update() was called since it was last checked from the client code.

Definition at line 51 of file TimingStats.h.

◆ getExpDecayAvg()

uint16_t ace_time::common::TimingStats::getExpDecayAvg ( ) const
inline

An exponential decay average.

Definition at line 41 of file TimingStats.h.


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