a
CEncoderFilter Class Reference
CEncoderFilter class. More...
#include <encoderfilter.hpp>
Inherits CEncoder.
Public Member Functions | |
CEncoderFilter (uint32_t f_period, float f_period_sec, uint32_t f_cpr, PinName f_pinName, CFilterFunction< float > &f_filter) | |
Constructor for the CEncoderFilter class. | |
virtual float | getSpeedRps () |
Get filtered rps value. | |
virtual int16_t | getCount ()=0 |
Getter filtered count value. | |
virtual void | run () |
Run method. | |
Protected Member Functions | |
virtual void | _run () |
Run method. |
Detailed Description
CEncoderFilter class.
It inherits class CEncoder. It is used for obtaining filtered encoder output.
Definition at line 23 of file encoderfilter.hpp.
Constructor & Destructor Documentation
CEncoderFilter | ( | uint32_t | f_period, |
float | f_period_sec, | ||
uint32_t | f_cpr, | ||
PinName | f_pinName, | ||
CFilterFunction< float > & | f_filter | ||
) |
Constructor for the CEncoderFilter class.
Constructor method
- Parameters:
-
[in] f_period period value [in] f_period_sec period value in seconds [in] f_cpr counts per revolution (rise and fall edges) [in] f_pinName digital pin connected to encoder output [in] f_filter reference to filter object
Definition at line 24 of file encoderFilter.cpp.
Member Function Documentation
void _run | ( | void | ) | [protected, virtual] |
Run method.
Method executed at predefined time intervals. Method called each f_period
Reimplemented from CEncoder.
Definition at line 59 of file encoderFilter.cpp.
int16_t getCount | ( | ) | [pure virtual] |
Getter filtered count value.
- Returns:
- int16_t
Reimplemented from CEncoder.
Definition at line 49 of file encoderFilter.cpp.
float getSpeedRps | ( | ) | [virtual] |
Get filtered rps value.
Method for getting filtererd rotations per second value
- Returns:
- filtered rps value
Reimplemented from CEncoder.
Definition at line 40 of file encoderFilter.cpp.
void run | ( | ) | [virtual, inherited] |
Generated on Tue Jul 12 2022 22:40:51 by 1.7.2