Classes | Public Member Functions | List of all members
Tools::Emb_PeriodicEventVerifier Class Reference

Tools::Emb_PeriodicEventVerifier. More...

#include <PeriodicEventsVerifier.h>


struct  Impl

Public Member Functions

 Emb_PeriodicEventVerifier ()
 Costructor. More...
 ~Emb_PeriodicEventVerifier ()
 Descructor. More...
bool init (double period, double tolerance, double min, double max, double step, double reportPeriod, const std::string &name={})
 Initializes the object with custom parameters. More...
void tick (double currentTime)
 Signals occurrence of the event to the object. More...

Detailed Description


This class let you to verify if a periodic event is triggered with the desired frequency. After its initialization, you need to tick it every event occurrence. The class prints the histogram of effective event timing every @reportPeriod, by yarp logger mechanism and resets the data collected until now.

Definition at line 44 of file PeriodicEventsVerifier.h.

Constructor & Destructor Documentation

◆ Emb_PeriodicEventVerifier()

Tools::Emb_PeriodicEventVerifier::Emb_PeriodicEventVerifier ( )


Definition at line 143 of file PeriodicEventsVerifier.cpp.

◆ ~Emb_PeriodicEventVerifier()

Tools::Emb_PeriodicEventVerifier::~Emb_PeriodicEventVerifier ( )


Definition at line 146 of file PeriodicEventsVerifier.cpp.

Member Function Documentation

◆ init()

bool Tools::Emb_PeriodicEventVerifier::init ( double  period,
double  tolerance,
double  min,
double  max,
double  step,
double  reportPeriod,
const std::string &  name = {} 

Initializes the object with custom parameters.

periodis the desired period of the event [expressed in seconds].
toleranceis the acceptable tolerance of the desired period [expressed in seconds].
minis the minimum period you expected [expressed in seconds].
maxis the maximum period you expected [expressed in seconds].
stepis the step of the histogram. [expressed in seconds].
reportPeriodthe class prints the histogram every @reportPeriod seconds. [expressed in seconds].
nameused in the print of histogram
true/false on success/failure.
the number of histogram columns are: ((@max-@min)/@step ) +2

Definition at line 152 of file PeriodicEventsVerifier.cpp.

◆ tick()

void Tools::Emb_PeriodicEventVerifier::tick ( double  currentTime)

Signals occurrence of the event to the object.

currentTimethe current time [expressed in seconds].

Definition at line 157 of file PeriodicEventsVerifier.cpp.

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