src/NMEA/ThermalLocator.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_LOCATOR_HPP
  25 #define XCSOAR_NMEA_THERMAL_LOCATOR_HPP
  26
  27 #include "Geo/GeoPoint.hpp"
  28 #include "Util/TrivialArray.hpp"
  29
  30 #include <type_traits>
  31
  32 struct SpeedVector;
  33
  34 /** Structure to hold information on identified thermal sources on the ground */
  35 struct ThermalSource
  36 {
  37   GeoPoint location;
  38   fixed ground_height;
  39   fixed lift_rate;
  40   fixed time;
  41
  42   GeoPoint CalculateAdjustedLocation(fixed altitude,
  43                                      const SpeedVector &wind) const;
  44 };
  45
  46 /** Structure for current thermal estimate from ThermalLocator */
  47 struct ThermalLocatorInfo
  48 {
  49   static constexpr unsigned MAX_SOURCES = 20;
  50
  51   /** Location of thermal at aircraft altitude */
  52   GeoPoint estimate_location;
  53   /** Is thermal estimation valid? */
  54   bool estimate_valid;
  55
  56   /** Position and data of the last thermal sources */
  57   TrivialArray<ThermalSource, MAX_SOURCES> sources;
  58
  59   void Clear();
  60
  61   /**
  62    * Allocate a new #THERMAL_SOURCE_INFO slot; discard the oldest one
  63    * if the list is full.
  64    */
  65   ThermalSource &AllocateSource();
  66 };
  67
  68 static_assert(std::is_trivial<ThermalLocatorInfo>::value,
  69               "type is not trivial");
  70
  71 #endif