src/Navaids/airways.hxx

   1 // airways.hxx - storage of airways network, and routing between nodes
   2 // Written by James Turner, started 2009.
   3 //
   4 // Copyright (C) 2009  Curtis L. Olson
   5 //
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License as
   8 // published by the Free Software Foundation; either version 2 of the
   9 // License, or (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19
  20 #ifndef FG_AIRWAYS_HXX
  21 #define FG_AIRWAYS_HXX
  22
  23 #include <map>
  24 #include <vector>
  25
  26 #include <Navaids/route.hxx>
  27 #include <Navaids/positioned.hxx>
  28
  29 class SGPath;
  30 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
  31
  32 namespace flightgear {
  33
  34 // forward declare some helpers
  35 struct SearchContext;
  36 class AdjacentWaypoint;
  37 class InAirwayFilter;
  38
  39 class Airway
  40 {
  41 public:
  42   virtual std::string ident() const
  43   { return _ident; }
  44
  45   static void load(const SGPath& path);
  46
  47   /**
  48    * Track a network of airways
  49    *
  50    */
  51   class Network
  52   {
  53   public:
  54     friend class Airway;
  55     friend class InAirwayFilter;
  56
  57
  58     /**
  59      * Principal routing algorithm. Attempts to find the best route beween
  60      * two points. If either point is part of the airway network (e.g, a SID
  61      * or STAR transition), it will <em>not</em> be duplicated in the result
  62      * path.
  63      *
  64      * Returns true if a route could be found, or false otherwise.
  65      */
  66     bool route(WayptRef aFrom, WayptRef aTo, WayptVec& aPath);
  67   private:
  68     void addEdge(int aWay, const SGGeod& aStartPos,
  69                 const std::string& aStartIdent,
  70                 const SGGeod& aEndPos, const std::string& aEndIdent);
  71
  72     int findAirway(const std::string& aName, double aTop, double aBase);
  73
  74     bool cleanGeneratedPath(WayptRef aFrom, WayptRef aTo, WayptVec& aPath,
  75                             bool exactTo, bool exactFrom);
  76
  77     bool search2(FGPositionedRef aStart, FGPositionedRef aDest, WayptVec& aRoute);
  78
  79     /**
  80      * Test if a positioned item is part of this airway network or not.
  81      */
  82     bool inNetwork(PositionedID pos) const;
  83
  84     /**
  85      * Find the closest node on the network, to the specified waypoint
  86      *
  87      * May return NULL,false if no match could be found; the search is
  88      * internally limited to avoid very poor performance; for example,
  89      * in the middle of an ocean.
  90      *
  91      * The second return value indicates if the returned value is
  92      * equal (true) or distinct (false) to the input waypoint.
  93      * Equality here means being physically within a close tolerance,
  94      * on the order of a hundred metres.
  95      */
  96     std::pair<FGPositionedRef, bool> findClosestNode(WayptRef aRef);
  97
  98     /**
  99      * Overloaded version working with a raw SGGeod
 100      */
 101
 102     std::pair<FGPositionedRef, bool> findClosestNode(const SGGeod& aGeod);
 103
 104     /**
 105      * cache which positioned items are in this network
 106      */
 107     typedef std::map<PositionedID, bool> NetworkMembershipDict;
 108     mutable NetworkMembershipDict _inNetworkCache;
 109
 110     int _networkID;
 111   };
 112
 113
 114   static Network* highLevel();
 115   static Network* lowLevel();
 116
 117 private:
 118   Airway(const std::string& aIdent, double aTop, double aBottom);
 119
 120   friend class Network;
 121
 122   std::string _ident;
 123   double _topAltitudeFt;
 124   double _bottomAltitudeFt;
 125
 126   WayptVec _elements;
 127 };
 128
 129 } // of namespace flightgear
 130
 131
 132 #endif //of FG_AIRWAYS_HXX