iCub-main
Classes | Public Member Functions | List of all members
embot::tools::PeriodValidator Class Reference

#include <embot_tools.h>

Classes

struct  Config
 
struct  Impl
 

Public Member Functions

 PeriodValidator ()
 
 ~PeriodValidator ()
 
bool init (const Config &config)
 
bool tick (std::uint64_t currtime_usec, std::uint64_t &deltatime_usec)
 
bool reset ()
 
bool report () const
 
bool alert (std::uint64_t &deltatime_usec) const
 
const embot::tools::Histogramhistogram () const
 
bool isInited () const
 
void how2use ()
 

Detailed Description

Definition at line 94 of file embot_tools.h.

Constructor & Destructor Documentation

◆ PeriodValidator()

embot::tools::PeriodValidator::PeriodValidator ( )

Definition at line 521 of file embot_tools.cpp.

◆ ~PeriodValidator()

embot::tools::PeriodValidator::~PeriodValidator ( )

Definition at line 527 of file embot_tools.cpp.

Member Function Documentation

◆ alert()

bool embot::tools::PeriodValidator::alert ( std::uint64_t &  deltatime_usec) const

Definition at line 551 of file embot_tools.cpp.

◆ histogram()

const embot::tools::Histogram * embot::tools::PeriodValidator::histogram ( ) const

Definition at line 562 of file embot_tools.cpp.

◆ how2use()

void embot::tools::PeriodValidator::how2use ( )
inline

Definition at line 136 of file embot_tools.h.

◆ init()

bool embot::tools::PeriodValidator::init ( const Config config)

Definition at line 533 of file embot_tools.cpp.

◆ isInited()

bool embot::tools::PeriodValidator::isInited ( ) const

◆ report()

bool embot::tools::PeriodValidator::report ( ) const

Definition at line 556 of file embot_tools.cpp.

◆ reset()

bool embot::tools::PeriodValidator::reset ( )

Definition at line 545 of file embot_tools.cpp.

◆ tick()

bool embot::tools::PeriodValidator::tick ( std::uint64_t  currtime_usec,
std::uint64_t &  deltatime_usec 
)

Definition at line 539 of file embot_tools.cpp.


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