scott/InfiniTime
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases 1 Wiki Activity

Added more descriptive comments in doxygen format.

Browse source
This commit is contained in:
panky-codes 2021-01-17 11:06:24 +01:00
parent 952021cdb6
commit b31c0e7e45
1 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/components/battery/BatteryController.h
View file

@ -6,15 +6,21 @@
namespace Pinetime {
namespace Controllers {
// A simple circular buffer that can be used to average
// out the sensor values
/** A simple circular buffer that can be used to average
out the sensor values. The total capacity of the CircBuffer
is given as the template parameter N.
*/
template <int N>
class CircBuffer {
public:
CircBuffer() : arr{}, sz{}, cap{N}, loc{} {}
CircBuffer() : arr{}, sz{}, cap{N}, head{} {}
/**
insert member function overwrites the next data to the current
HEAD and moves the HEAD to the newly inserted value.
*/
void insert(const int num) {
loc %= cap;
arr[loc++] = num;
head %= cap;
arr[head++] = num;
if (sz != cap) {
sz++;
}
@ -26,10 +32,10 @@ namespace Pinetime {
}
private:
std::array<int, N> arr;
uint8_t sz;
uint8_t cap;
uint8_t loc;
std::array<int, N> arr; /**< internal array used to store the values*/
uint8_t sz; /**< The current size of the array.*/
uint8_t cap; /**< Total capacity of the CircBuffer.*/
uint8_t head; /**< The current head of the CircBuffer*/
};
class Battery {