src/Task/MapTaskManager.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 MAPTASKMANAGER_H
  24 #define MAPTASKMANAGER_H
  25
  26 struct Waypoint;
  27 class OrderedTask;
  28
  29 /**
  30  * Appends wp to current Ordered task and activates the ordered task if
  31  * the current ordered task is valid.
  32  * If the current ordered task is invalid or empty, then
  33  * either creates a Goto task with the selected waypoint, or if in Goto mode
  34  * already, it creates an ordered task from the previous Goto point and the
  35  * selected waypoint.
  36  */
  37 namespace MapTaskManager
  38 {
  39   enum TaskEditResult {
  40     SUCCESS,
  41     UNMODIFIED,
  42     INVALID,
  43     NOTASK,
  44     MUTATED_TO_GOTO,
  45     MUTATED_FROM_GOTO,
  46   };
  47
  48   TaskEditResult AppendToTask(const Waypoint &wp);
  49   TaskEditResult InsertInTask(const Waypoint &wp);
  50
  51   /**
  52    * inserts the waypoint into the Ordered Task
  53    * It is up to the caller to decide whether to commit the new task or not.
  54    * Task manager must be in Ordered Mode when called
  55    * @param task.  Pointer to an ordered Mat task
  56    * @param waypoint.  The wp to insert into the task before the active tp
  57    */
  58   TaskEditResult InsertInMatProForma(OrderedTask &task,
  59                                      const Waypoint &waypoint);
  60   TaskEditResult ReplaceInTask(const Waypoint &wp);
  61   TaskEditResult RemoveFromTask(const Waypoint &wp);
  62
  63   /**
  64    * @param wp
  65    * @return TurnPointIndex if MODE_ORDERED and wp is in task
  66    * else returns -1
  67    */
  68   int GetIndexInTask(const Waypoint &wp);
  69
  70   /**
  71    * is this wp an unachieved task point?
  72    * @param waypoint.  the wp being tested
  73    * @return.  -1 or last index in ordered task where the wp is an
  74    * unachieved intermediate point.  -1 if mode != MODE_ORDDERED
  75    */
  76   int GetUnachievedIndexInTask(const Waypoint &waypoint);
  77 };
  78
  79 #endif