src/Task/Serialiser.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 #ifndef SERIALISER_HPP
  23 #define SERIALISER_HPP
  24
  25 #include "Task/Visitors/TaskPointVisitor.hpp"
  26 #include "Task/Factory/TaskFactoryType.hpp"
  27 #include "Task/Ordered/OrderedTaskBehaviour.hpp"
  28
  29 #include <tchar.h>
  30
  31 class DataNode;
  32 struct GeoPoint;
  33 struct Waypoint;
  34 class OrderedTask;
  35 class OrderedTaskPoint;
  36 class ObservationZonePoint;
  37 class SectorZone;
  38 class LineSectorZone;
  39 class CylinderZone;
  40 class AnnularSectorZone;
  41 class SymmetricSectorZone;
  42
  43 /**
  44  * Class to serialise and de-serialise tasks to/from a #DataNode structure
  45  */
  46 class Serialiser {
  47   DataNode &node;
  48
  49   bool mode_optional_start;
  50
  51 public:
  52   /**
  53    * Constructor
  54    *
  55    * @param the_node Node this serialiser will edit
  56    * @param _waypoints a waypoint database to merge with (optional)
  57    *
  58    * @return Initialised object
  59    */
  60   Serialiser(DataNode &_node)
  61     :node(_node), mode_optional_start(false) {};
  62
  63   /**
  64    * Serialise a task (create a DataNode structure to reflect the task)
  65    *
  66    * @param data OrderedTask to serialise
  67    */
  68   void Serialise(const OrderedTask &task);
  69
  70   void Visit(const SectorZone &data);
  71   void Visit(const LineSectorZone &data);
  72   void Visit(const CylinderZone &data);
  73   void Visit(const AnnularSectorZone &data);
  74   void Visit(const SymmetricSectorZone &data);
  75
  76 protected:
  77   /**
  78    * Serialise OrderedTaskBehaviour
  79    *
  80    * @param data Item to serialise
  81    */
  82   void Serialise(const OrderedTaskBehaviour &data);
  83
  84   /**
  85    * Serialise a Waypoint
  86    *
  87    * @param data Item to serialise
  88    */
  89   void Serialise(const Waypoint &data);
  90
  91   /**
  92    * Serialise a GeoPoint
  93    *
  94    * @param data Item to serialise
  95    */
  96   void Serialise(const GeoPoint &data);
  97
  98   /**
  99    * Serialise an ObservationZonePoint
 100    *
 101    * @param data Item to serialise
 102    */
 103   void Serialise(const ObservationZonePoint &data);
 104
 105   /**
 106    * Serialise an OrderedTaskPoint
 107    *
 108    * @param data Item to serialise
 109    * @param name Type of point
 110    */
 111   void Serialise(const OrderedTaskPoint &data, const TCHAR* name);
 112   void Serialise(const OrderedTaskPoint &tp);
 113
 114 private:
 115   const TCHAR *GetTaskFactoryType(TaskFactoryType type) const;
 116   const TCHAR *GetHeightRef(AltitudeReference height_ref) const;
 117 };
 118
 119 #endif