Merge pull request #2 from whati001/#1-missing-dTor

AK - added ctor and dtor

Author: GatCode

src/ScaleStabilizer.cpp

@@ -1,12 +1,26 @@
 #include "ScaleStabilizer.h"
 
+/*!
+ * @brief Construct a new Scale Stabilizer:: S Cale Stabilizer object
+ */
+ScaleStabilizer::SCaleStabilizer()
+{
+}
+
+ScaleStabilizer::~ScaleStabilizer()
+{
+  delete _window;
+}
+
 /*!
  * @brief simple average calculation
  */
-double ScaleStabilizer::getAvg() {
+double ScaleStabilizer::getAvg()
+{
   double sum = 0;
-  
-  for (int i = 0; i < _windowSize; i++) {
+
+  for (int i = 0; i < _windowSize; i++)
+  {
     sum += _window[i];
   }
 
@@ -16,9 +30,12 @@ double ScaleStabilizer::getAvg() {
 /*!
  * @brief checks if all the elements in the moving _window are the same
  */
-bool ScaleStabilizer::isBufferMonotone() {
-  for (int i = 0; i < _windowSize; i++) {
-    if (_window[i] != _window[0]) {
+bool ScaleStabilizer::isBufferMonotone()
+{
+  for (int i = 0; i < _windowSize; i++)
+  {
+    if (_window[i] != _window[0])
+    {
       break;
     }
   }
@@ -27,7 +44,8 @@ bool ScaleStabilizer::isBufferMonotone() {
 /*!
  * @brief init of the stabilizer
  */
-void ScaleStabilizer::begin(int windowSize, double weightThreshold) {
+void ScaleStabilizer::begin(int windowSize, double weightThreshold)
+{
   _windowSize = windowSize;
   _weightThreshold = weightThreshold;
   _window = new double[_windowSize];
@@ -40,26 +58,30 @@ void ScaleStabilizer::begin(int windowSize, double weightThreshold) {
  * @brief add a new ADC reading to the moving _window by replacing the olest one
  * but if the moving _window is empty or needs to be overwritten, force overwrite is executed
  */
-void ScaleStabilizer::add(double reading) {
-  if (_forceOverwrite > 0 || isBufferMonotone()) {
+void ScaleStabilizer::add(double reading)
+{
+  if (_forceOverwrite > 0 || isBufferMonotone())
+  {
     int oldestReadingIdx = (_currentReadingIdx + 1) % _windowSize;
     _window[oldestReadingIdx] = reading;
     _currentReadingIdx = oldestReadingIdx;
     _forceOverwrite--;
     return;
   }
 
-  if (abs(reading - getAvg()) < _weightThreshold) {
+  if (abs(reading - getAvg()) < _weightThreshold)
+  {
     int oldestReadingIdx = (_currentReadingIdx + 1) % _windowSize;
     _window[oldestReadingIdx] = reading;
     _currentReadingIdx = oldestReadingIdx;
     return;
   }
 
-   // reading index just before the last one
-  int nextToLastReadingIdx = _currentReadingIdx - 1 < 0 ? _windowSize : (_currentReadingIdx - 1) % _windowSize; 
+  // reading index just before the last one
+  int nextToLastReadingIdx = _currentReadingIdx - 1 < 0 ? _windowSize : (_currentReadingIdx - 1) % _windowSize;
 
-  if (abs(_window[nextToLastReadingIdx] - getAvg()) > _weightThreshold) {
+  if (abs(_window[nextToLastReadingIdx] - getAvg()) > _weightThreshold)
+  {
     // replace 75% of the data in the filter _window with fresh readings
     _forceOverwrite = _windowSize * 0.75;
   }
@@ -70,23 +92,29 @@ void ScaleStabilizer::add(double reading) {
 /*!
  * @brief returns the stabilized average reading from the moving _window
  */
-double ScaleStabilizer::getStablilizedReading(double displayResolution, int decimalPlaces) {
+double ScaleStabilizer::getStablilizedReading(double displayResolution, int decimalPlaces)
+{
   // find min and max values
   int minIdx = 0;
   int maxIdx = 0;
-  for (int i = 0; i < _windowSize; i++) {
-    if (_window[i] < minIdx) {
+  for (int i = 0; i < _windowSize; i++)
+  {
+    if (_window[i] < minIdx)
+    {
       minIdx = i;
     }
-    if (_window[i] > maxIdx) {
+    if (_window[i] > maxIdx)
+    {
       maxIdx = i;
     }
   }
 
   // remove min and max from measurements
   double sum = 0;
-  for (int i = 0; i < _windowSize; i++) {
-    if (i == minIdx || i == maxIdx) {
+  for (int i = 0; i < _windowSize; i++)
+  {
+    if (i == minIdx || i == maxIdx)
+    {
       continue;
     }
     sum += _window[i];
@@ -96,7 +124,8 @@ double ScaleStabilizer::getStablilizedReading(double displayResolution, int deci
   double cleanedAverage = sum / (_windowSize - 2);
 
   // remove negative numbers and set to 0 if close to 0
-  if (cleanedAverage < 0.5) {
+  if (cleanedAverage < 0.5)
+  {
     cleanedAverage = 0.0;
   }
 
@@ -105,11 +134,13 @@ double ScaleStabilizer::getStablilizedReading(double displayResolution, int deci
   cleanedAverage = round(cleanedAverage * scale) / scale;
 
   // perform the output flicker reduction
-  if (_lastOutputValue == cleanedAverage) {
+  if (_lastOutputValue == cleanedAverage)
+  {
     return cleanedAverage;
   }
-  
-  if(abs(cleanedAverage - _lastOutputValue) < displayResolution) {
+
+  if (abs(cleanedAverage - _lastOutputValue) < displayResolution)
+  {
     return _lastOutputValue; // probably was just noise - return the old measurement
   }
 

src/ScaleStabilizer.h

@@ -3,9 +3,10 @@
 
 #include "Arduino.h"
 
-class ScaleStabilizer {
+class ScaleStabilizer
+{
 private:
-  double* _window;
+  double *_window;
   int _windowSize;
   double _weightThreshold;
   int _forceOverwrite;
@@ -25,6 +26,16 @@ class ScaleStabilizer {
   bool isBufferMonotone();
 
 public:
+  /*!
+   * @brief Construct a new Scale Stabilizer object
+   */
+  ScaleStabilizer();
+
+  /*!
+   * @brief Destroy the Scale Stabilizer object
+   */
+  ~ScaleStabilizer();
+
   /*!
    * @brief ScaleStabilizer begin initializer
    * @param windowSize represents the size of the moving window