src/CalculationThread.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_CALCULATION_THREAD_HPP
  25 #define XCSOAR_CALCULATION_THREAD_HPP
  26
  27 #include "Thread/WorkerThread.hpp"
  28 #include "Thread/Mutex.hpp"
  29 #include "Computer/Settings.hpp"
  30
  31 class GlideComputer;
  32
  33 /**
  34  * The CalculationThread handles all expensive calculations
  35  * that should not be done directly in the device thread.
  36  * Data transfer is handled by a blackboard system.
  37  */
  38 class CalculationThread final : public WorkerThread {
  39   /**
  40    * This mutex protects #settings_computer and
  41    * #screen_distance_meters.
  42    */
  43   Mutex mutex;
  44
  45   /**
  46    * This flag forces a full run of all calculations.  It is set after
  47    * important non-GPS data has changed, e.g. the task has been
  48    * edited.
  49    */
  50   bool force;
  51
  52   ComputerSettings settings_computer;
  53
  54   fixed screen_distance_meters;
  55
  56   /** Pointer to the GlideComputer that should be used */
  57   GlideComputer &glide_computer;
  58
  59 public:
  60   CalculationThread(GlideComputer &_glide_computer);
  61
  62   void SetComputerSettings(const ComputerSettings &new_value);
  63   void SetScreenDistanceMeters(fixed new_value);
  64
  65   bool Start(bool suspended=false) {
  66     if (!WorkerThread::Start(suspended))
  67       return false;
  68
  69     SetLowPriority();
  70     return true;
  71   }
  72
  73   void ForceTrigger();
  74
  75 protected:
  76   virtual void Tick();
  77 };
  78
  79 #endif