src/NMEA/ClimbHistory.hpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #ifndef XCSOAR_CLIMB_HISTORY_HPP
  25 #define XCSOAR_CLIMB_HISTORY_HPP
  26
  27 #include "Math/fixed.hpp"
  28
  29 #include <type_traits>
  30
  31 #include <assert.h>
  32
  33 /**
  34  * Derived climb rate history
  35  *
  36  */
  37 class ClimbHistory {
  38   /**
  39    * Store vario history from 0 to 360 kph.
  40    */
  41   static constexpr unsigned SIZE = 100;
  42
  43   /** Average climb rate for each episode */
  44   fixed vario[SIZE];
  45
  46   /** Number of samples in each episode */
  47   unsigned short count[SIZE];
  48
  49 public:
  50   void Clear();
  51
  52   void Add(unsigned speed, fixed vario);
  53
  54   /**
  55    * Do we have data for the specified speed?
  56    */
  57   bool Check(unsigned speed) const {
  58     return speed < SIZE && count[speed] > 0;
  59   }
  60
  61   /**
  62    * Returns the average climb rate for the specified speed.
  63    */
  64   fixed Get(unsigned speed) const {
  65     assert(speed < SIZE);
  66     assert(count[speed] > 0);
  67
  68     return vario[speed] / count[speed];
  69   }
  70 };
  71
  72 static_assert(std::is_trivial<ClimbHistory>::value, "type is not trivial");
  73
  74 #endif