Alex Pirciu
a
Embed:
(wiki syntax)
CEncoder Class Reference
#include <encoder.hpp>
Inherits task::CTask.
Inherited by CEncoderFilter.
Public Member Functions | |
| CEncoder (uint32_t f_period, float f_period_sec, uint32_t f_cpr, PinName f_pinName) | |
| Constructor for the CEncoder class. | |
| virtual float | getSpeedRps () |
| Get rps method. | |
| virtual int16_t | getCount () |
| Get count. | |
| virtual void | run () |
| Run method. | |
Protected Member Functions | |
| virtual void | _run () |
| Run method. | |
Detailed Description
CEncoder class.
It inherits class task::CTask. It is used for computing revolustions per second.
Definition at line 49 of file encoder.hpp.
Constructor & Destructor Documentation
| CEncoder | ( | uint32_t | f_period, |
| float | f_period_sec, | ||
| uint32_t | f_cpr, | ||
| PinName | f_pinName | ||
| ) |
Constructor for the CEncoder class.
Constructor method
- Parameters:
-
f_period period value f_period_sec period value in seconds f_cpr counts per revolution (rise and fall edges) f_pinName digital pin connected to encoder output
Definition at line 76 of file encoder.cpp.
Member Function Documentation
| void _run | ( | void | ) | [protected, virtual] |
Run method.
Method executed at predefined time intervals. Method called each f_period
Implements CTask.
Reimplemented in CEncoderFilter.
Definition at line 121 of file encoder.cpp.
| int16_t getCount | ( | ) | [virtual] |
Get count.
Returns the value of the count
- Returns:
- rps
Reimplemented in CEncoderFilter.
Definition at line 107 of file encoder.cpp.
| float getSpeedRps | ( | ) | [virtual] |
Get rps method.
Returns the value of the rotations per second value
- Returns:
- rps
Reimplemented in CEncoderFilter.
Definition at line 95 of file encoder.cpp.
| void run | ( | ) | [virtual, inherited] |
Generated on Tue Jul 12 2022 22:40:51 by
1.7.2