EEROS  1.0.0.0
API for the EEROS Real-Time Robotics Framework
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
eeros::PeriodicCounter Class Reference

#include <PeriodicCounter.hpp>

Collaboration diagram for eeros::PeriodicCounter:
Collaboration graph
[legend]

Public Types

using Logger = logger::Logger
 
using MonitorFunc = std::function< void(PeriodicCounter &, Logger &)>
 

Public Member Functions

 PeriodicCounter (double period=0, unsigned logger_category=0)
 
void setPeriod (double period)
 
void setResetTime (double sec)
 
void addDefaultMonitor (double tolerance=0.05)
 
void tick ()
 
void tock ()
 
void reset ()
 
void operator>> (eeros::logger::LogEntry &event)
 
void operator>> (eeros::logger::LogEntry &&event)
 

Static Public Member Functions

static void addDefaultMonitor (std::vector< MonitorFunc > &monitors, double period, double tolerance=0.05)
 

Public Attributes

Statistics period
 
Statistics jitter
 
Statistics run
 
std::vector< MonitorFunc > monitors
 

Member Typedef Documentation

using eeros::PeriodicCounter::Logger = logger::Logger
using eeros::PeriodicCounter::MonitorFunc = std::function<void(PeriodicCounter&, Logger&)>

Constructor & Destructor Documentation

PeriodicCounter::PeriodicCounter ( double  period = 0,
unsigned  logger_category = 0 
)

Member Function Documentation

void PeriodicCounter::addDefaultMonitor ( double  tolerance = 0.05)
void PeriodicCounter::addDefaultMonitor ( std::vector< MonitorFunc > &  monitors,
double  period,
double  tolerance = 0.05 
)
static
void PeriodicCounter::operator>> ( eeros::logger::LogEntry &  event)
void PeriodicCounter::operator>> ( eeros::logger::LogEntry &&  event)
void PeriodicCounter::reset ( )
void PeriodicCounter::setPeriod ( double  period)
void PeriodicCounter::setResetTime ( double  sec)
void PeriodicCounter::tick ( )
void PeriodicCounter::tock ( )

Member Data Documentation

Statistics eeros::PeriodicCounter::jitter
std::vector<MonitorFunc> eeros::PeriodicCounter::monitors
Statistics eeros::PeriodicCounter::period
Statistics eeros::PeriodicCounter::run
The documentation for this class was generated from the following files: