src/Computer/Wind/CirclingWind.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_CIRCLING_WIND_HPP
  25 #define XCSOAR_CIRCLING_WIND_HPP
  26
  27 #include "Geo/SpeedVector.hpp"
  28 #include "Util/StaticArray.hpp"
  29 #include "NMEA/Validity.hpp"
  30
  31 struct MoreData;
  32 struct DerivedInfo;
  33
  34 /**
  35  * Class to provide wind estimates from circling
  36  */
  37 class CirclingWind
  38 {
  39   /**
  40    * The windanalyser analyses the list of flightsamples looking for
  41    * windspeed and direction.
  42    */
  43   struct Sample
  44   {
  45     fixed time;
  46     SpeedVector vector;
  47   };
  48
  49   Validity last_track_available, last_ground_speed_available;
  50
  51   // we are counting the number of circles, the first onces are probably not very round
  52   int circle_count;
  53   // active is set to true or false by the slot_newFlightMode slot
  54   bool active;
  55
  56   /**
  57    * The angle turned in the current circle.
  58    */
  59   Angle current_circle;
  60
  61   Angle last_track;
  62
  63   StaticArray<Sample, 50> samples;
  64
  65 public:
  66   struct Result
  67   {
  68     unsigned quality;
  69     SpeedVector wind;
  70
  71     Result() {}
  72     Result(unsigned _quality):quality(_quality) {}
  73     Result(unsigned _quality, SpeedVector _wind)
  74       :quality(_quality), wind(_wind) {}
  75
  76     bool IsValid() const {
  77       return quality > 0;
  78     }
  79   };
  80
  81   /**
  82    * Clear as if never flown
  83    */
  84   void Reset();
  85
  86   /**
  87    * Called if the flightmode changes
  88    */
  89   void NewFlightMode(const DerivedInfo &derived);
  90
  91   /**
  92    * Called if a new sample is available in the samplelist.
  93    */
  94   Result NewSample(const MoreData &info);
  95
  96 private:
  97   Result CalcWind();
  98 };
  99
 100 #endif