src/Task/ProtectedTaskManager.hpp

   1 /* Copyright_License {
   2
   3   XCSoar Glide Computer - http://www.xcsoar.org/
   4   Copyright (C) 2000-2013 The XCSoar Project
   5   A detailed list of copyright holders can be found in the file "AUTHORS".
   6
   7   This program is free software; you can redistribute it and/or
   8   modify it under the terms of the GNU General Public License
   9   as published by the Free Software Foundation; either version 2
  10   of the License, or (at your option) any later version.
  11
  12   This program is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program; if not, write to the Free Software
  19   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20 }
  21  */
  22
  23 #ifndef XCSOAR_PROTECTED_TASK_MANAGER_HPP
  24 #define XCSOAR_PROTECTED_TASK_MANAGER_HPP
  25
  26 #include "Thread/Guard.hpp"
  27 #include "Task/TaskManager.hpp"
  28 #include "Engine/Task/Unordered/AbortIntersectionTest.hpp"
  29 #include "Compiler.h"
  30
  31 #include <tchar.h>
  32
  33 class GlidePolar;
  34 class RoutePlannerGlue;
  35 struct RangeAndRadial;
  36
  37 class ReachIntersectionTest: public AbortIntersectionTest {
  38   const RoutePlannerGlue *route;
  39
  40 public:
  41   ReachIntersectionTest(): route(NULL) {};
  42
  43   void SetRoute(const RoutePlannerGlue *_route) {
  44     route = _route;
  45   }
  46
  47   virtual bool Intersects(const AGeoPoint& destination);
  48 };
  49
  50 /**
  51  * Facade to task/airspace/waypoints as used by threads,
  52  * to manage locking
  53  */
  54 class ProtectedTaskManager: public Guard<TaskManager>
  55 {
  56 protected:
  57   const TaskBehaviour &task_behaviour;
  58   ReachIntersectionTest intersection_test;
  59
  60   static const TCHAR default_task_path[];
  61
  62 public:
  63   ProtectedTaskManager(TaskManager &_task_manager, const TaskBehaviour &tb);
  64
  65   ~ProtectedTaskManager();
  66
  67   // common accessors for ui and calc clients
  68   void SetGlidePolar(const GlidePolar &glide_polar);
  69
  70   gcc_pure
  71   const OrderedTaskBehaviour GetOrderedTaskBehaviour() const;
  72
  73   gcc_pure
  74   const Waypoint* GetActiveWaypoint() const;
  75
  76   void IncrementActiveTaskPoint(int offset);
  77   void IncrementActiveTaskPointArm(int offset);
  78
  79   bool DoGoto(const Waypoint &wp);
  80
  81   gcc_pure
  82   AircraftState GetStartState() const;
  83
  84   gcc_pure
  85   fixed GetFinishHeight() const;
  86
  87   gcc_malloc
  88   OrderedTask* TaskClone() const;
  89
  90   /**
  91    * Copy task into this task
  92    *
  93    * @param other OrderedTask to copy
  94    * @return True if this task changed
  95    */
  96   bool TaskCommit(const OrderedTask& that);
  97
  98   bool TaskSave(const TCHAR *path);
  99
 100   bool TaskSaveDefault();
 101
 102   /**
 103    * Creates an ordered task based on the Default.tsk file
 104    * Consumer's responsibility to delete task
 105    *
 106    * @param waypoints waypoint structure
 107    * @param failfactory default task type used if Default.tsk is invalid
 108    * @return OrderedTask from Default.tsk file or if Default.tsk is invalid
 109    * or non-existent, returns empty task with defaults set by
 110    * config task defaults
 111    */
 112   gcc_malloc
 113   OrderedTask* TaskCreateDefault(const Waypoints *waypoints,
 114                                  TaskFactoryType factory);
 115
 116   bool TaskSave(const TCHAR* path, const OrderedTask& task);
 117
 118   /** Reset the tasks (as if never flown) */
 119   void Reset();
 120
 121   /**
 122    * Lock/unlock the target from automatic shifts of specified tp
 123    *
 124    * @param index index of tp in task
 125    * @param do_lock Whether to lock the target
 126    */
 127   bool TargetLock(const unsigned index, bool do_lock);
 128
 129   void SetRoutePlanner(const RoutePlannerGlue *_route);
 130
 131   short GetTerrainBase() const;
 132 };
 133
 134 #endif