src/NMEA/ThermalBand.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_NMEA_THERMAL_BAND_H
  25 #define XCSOAR_NMEA_THERMAL_BAND_H
  26
  27 #include "Math/fixed.hpp"
  28
  29 #include <type_traits>
  30
  31 /**
  32  * Derived thermal climb rate histogram by altitude (time averaged)
  33  */
  34 struct ThermalBandInfo
  35 {
  36   static constexpr unsigned NUMTHERMALBUCKETS = 10;
  37
  38   /** Height above working band/safety (m) */
  39   fixed working_band_height;
  40
  41   /** Absolute ceiling of climbs (m) */
  42   fixed working_band_ceiling;
  43
  44   /** Fraction of working band height */
  45   fixed working_band_fraction;
  46
  47   /** Maximum height achieved in circling */
  48   fixed max_thermal_height;
  49   /** Number of samples in each bucket */
  50   int thermal_profile_n[NUMTHERMALBUCKETS];
  51   /** Average climb rate in each bucket */
  52   fixed thermal_profile_w[NUMTHERMALBUCKETS];
  53
  54   void Clear();
  55
  56   /**
  57    * Calculates the bucket number for the specified height.
  58    */
  59   unsigned BucketForHeight(fixed height) const;
  60
  61   /**
  62    * Calculates the base height of the specified bucket.
  63    */
  64   fixed BucketHeight(unsigned bucket) const;
  65
  66   void Add(const fixed height, const fixed total_energy_vario);
  67
  68 private:
  69   void Expand(const fixed height);
  70 };
  71
  72 static_assert(std::is_trivial<ThermalBandInfo>::value, "type is not trivial");
  73
  74 #endif