iCub-main
Classes | Public Member Functions | Public Attributes | List of all members
mced::mcEventDownsampler Class Reference

#include <mcEventDownsampler.h>

Classes

struct  Config
 

Public Member Functions

 mcEventDownsampler ()
 Construct a new Event Downsampler object and instantiates the mutex needed by the timer. More...
 
 ~mcEventDownsampler ()
 Destroy the Event Downsampler object. More...
 
bool start ()
 Instantiates the yarp::os::Timer object and starts it. More...
 
bool stop ()
 Stops the timer. More...
 
bool canprint ()
 Called by the object that implements the downsampler. More...
 

Public Attributes

Config config
 

Detailed Description

Definition at line 17 of file mcEventDownsampler.h.

Constructor & Destructor Documentation

◆ mcEventDownsampler()

mced::mcEventDownsampler::mcEventDownsampler ( )

Construct a new Event Downsampler object and instantiates the mutex needed by the timer.

Definition at line 11 of file mcEventDownsampler.cpp.

◆ ~mcEventDownsampler()

mced::mcEventDownsampler::~mcEventDownsampler ( )

Destroy the Event Downsampler object.

It stops the timer then deletes it.

Definition at line 16 of file mcEventDownsampler.cpp.

Member Function Documentation

◆ canprint()

bool mced::mcEventDownsampler::canprint ( )

Called by the object that implements the downsampler.

Compares the difference between counter and latch_1 is and the threshold.

Returns
true if the difference is lower or equal to the threshold, false if it is higher.

Definition at line 30 of file mcEventDownsampler.cpp.

◆ start()

bool mced::mcEventDownsampler::start ( )

Instantiates the yarp::os::Timer object and starts it.

Returns
true if the instantiation was successful, false otherwise.

Definition at line 62 of file mcEventDownsampler.cpp.

◆ stop()

bool mced::mcEventDownsampler::stop ( )

Stops the timer.

Returns
true if the operation was successful, false otherwise.

Definition at line 50 of file mcEventDownsampler.cpp.

Member Data Documentation

◆ config

Config mced::mcEventDownsampler::config

Definition at line 63 of file mcEventDownsampler.h.


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