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     double topAltitudeFt() const
  48     { return _topAltitudeFt; }
  49
  50     double bottomAltitudeFt() const
  51     { return _bottomAltitudeFt; }
  52
  53   /**
  54    * Track a network of airways
  55    *
  56    */
  57   class Network
  58   {
  59   public:
  60     friend class Airway;
  61     friend class InAirwayFilter;
  62
  63
  64     /**
  65      * Principal routing algorithm. Attempts to find the best route beween
  66      * two points. If either point is part of the airway network (e.g, a SID
  67      * or STAR transition), it will <em>not</em> be duplicated in the result
  68      * path.
  69      *
  70      * Returns true if a route could be found, or false otherwise.
  71      */
  72     bool route(WayptRef aFrom, WayptRef aTo, WayptVec& aPath);
  73   private:
  74     void addEdge(int aWay, const SGGeod& aStartPos,
  75                 const std::string& aStartIdent,
  76                 const SGGeod& aEndPos, const std::string& aEndIdent);
  77
  78     int findAirway(const std::string& aName, double aTop, double aBase);
  79
  80     bool cleanGeneratedPath(WayptRef aFrom, WayptRef aTo, WayptVec& aPath,
  81                             bool exactTo, bool exactFrom);
  82
  83     bool search2(FGPositionedRef aStart, FGPositionedRef aDest, WayptVec& aRoute);
  84
  85     /**
  86      * Test if a positioned item is part of this airway network or not.
  87      */
  88     bool inNetwork(PositionedID pos) const;
  89
  90     /**
  91      * Find the closest node on the network, to the specified waypoint
  92      *
  93      * May return NULL,false if no match could be found; the search is
  94      * internally limited to avoid very poor performance; for example,
  95      * in the middle of an ocean.
  96      *
  97      * The second return value indicates if the returned value is
  98      * equal (true) or distinct (false) to the input waypoint.
  99      * Equality here means being physically within a close tolerance,
 100      * on the order of a hundred metres.
 101      */
 102     std::pair<FGPositionedRef, bool> findClosestNode(WayptRef aRef);
 103
 104     /**
 105      * Overloaded version working with a raw SGGeod
 106      */
 107
 108     std::pair<FGPositionedRef, bool> findClosestNode(const SGGeod& aGeod);
 109
 110     /**
 111      * cache which positioned items are in this network
 112      */
 113     typedef std::map<PositionedID, bool> NetworkMembershipDict;
 114     mutable NetworkMembershipDict _inNetworkCache;
 115
 116     int _networkID;
 117   };
 118
 119
 120   static Network* highLevel();
 121   static Network* lowLevel();
 122
 123 private:
 124   Airway(const std::string& aIdent, double aTop, double aBottom);
 125
 126   friend class Network;
 127
 128   std::string _ident;
 129   double _topAltitudeFt;
 130   double _bottomAltitudeFt;
 131
 132   WayptVec _elements;
 133 };
 134
 135 } // of namespace flightgear
 136
 137
 138 #endif //of FG_AIRWAYS_HXX