src/BallastDumpManager.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 BALLAST_DUMP_MANAGER_HPP
  25 #define BALLAST_DUMP_MANAGER_HPP
  26
  27 #include "Time/PeriodClock.hpp"
  28
  29 class GlidePolar;
  30
  31 class BallastDumpManager
  32 {
  33   bool enabled;
  34   PeriodClock ballast_clock;
  35
  36 public:
  37   constexpr BallastDumpManager():enabled(false) {}
  38
  39   bool IsEnabled() const {
  40     return enabled;
  41   }
  42
  43   void Start();
  44   void Stop();
  45
  46   void SetEnabled(bool _enabled);
  47
  48   /**
  49    * Updates the ballast of the given GlidePolar.
  50    * This function must not be called if the BallastDumpManager is not enabled!
  51    * @param glide_polar The GlidePolar to update
  52    * @param dump_time Time that it takes to dump the entire ballast
  53    * @return True if ballast is not entirely dumped yet,
  54    *         False if we are dry now or dump_time is zero/unknown
  55    */
  56   bool Update(GlidePolar &glide_polar, unsigned dump_time);
  57 };
  58
  59 #endif