src/Navaids/NavDataCache.hxx

   1 /**
   2  * NavDataCache.hxx - defines a unified binary cache for navigation
   3  * data, parsed from various text / XML sources.
   4  */
   5
   6 // Written by James Turner, started 2012.
   7 //
   8 // Copyright (C) 2012 James Turner
   9 //
  10 // This program is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU General Public License as
  12 // published by the Free Software Foundation; either version 2 of the
  13 // License, or (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful, but
  16 // WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 // General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  23
  24 #ifndef FG_NAVDATACACHE_HXX
  25 #define FG_NAVDATACACHE_HXX
  26
  27 #include <memory>
  28
  29 #include <simgear/misc/strutils.hxx> // for string_list
  30 #include <Navaids/positioned.hxx>
  31
  32 class SGPath;
  33
  34 namespace flightgear
  35 {
  36
  37 /// a pair of airport ID, runway ID
  38 typedef std::pair<PositionedID, PositionedID> AirportRunwayPair;
  39
  40 typedef std::pair<FGPositioned::Type, PositionedID> TypedPositioned;
  41 typedef std::vector<TypedPositioned> TypedPositionedVec;
  42
  43 // pair of airway ID, destination node ID
  44 typedef std::pair<int, PositionedID> AirwayEdge;
  45 typedef std::vector<AirwayEdge> AirwayEdgeVec;
  46
  47 namespace Octree {
  48   class Node;
  49   class Branch;
  50 }
  51
  52 class NavDataCache
  53 {
  54 public:
  55     ~NavDataCache();
  56
  57 // singleton accessor
  58     static NavDataCache* instance();
  59
  60   /**
  61    * predicate - check if the cache needs to be rebuilt.
  62    * This can happen is the cache file is missing or damaged, or one of the
  63    ** global input files is changed.
  64    */
  65   bool isRebuildRequired();
  66
  67   /**
  68    * run the cache rebuild
  69    */
  70   void rebuild();
  71
  72   bool isCachedFileModified(const SGPath& path) const;
  73   void stampCacheFile(const SGPath& path);
  74
  75   int readIntProperty(const std::string& key);
  76   double readDoubleProperty(const std::string& key);
  77   std::string readStringProperty(const std::string& key);
  78
  79   void writeIntProperty(const std::string& key, int value);
  80   void writeStringProperty(const std::string& key, const std::string& value);
  81   void writeDoubleProperty(const std::string& key, const double& value);
  82
  83   string_list readStringListProperty(const std::string& key);
  84   void writeStringListProperty(const std::string& key, const string_list& values);
  85
  86   FGPositioned* loadById(PositionedID guid);
  87
  88   PositionedID insertAirport(FGPositioned::Type ty, const std::string& ident,
  89                              const std::string& name);
  90   void insertTower(PositionedID airportId, const SGGeod& pos);
  91   PositionedID insertRunway(FGPositioned::Type ty, const std::string& ident,
  92                           const SGGeod& pos, PositionedID apt,
  93                           double heading, double length, double width, double displacedThreshold,
  94                           double stopway, int surfaceCode);
  95   void setRunwayReciprocal(PositionedID runway, PositionedID recip);
  96   void setRunwayILS(PositionedID runway, PositionedID ils);
  97
  98   void updateRunwayThreshold(PositionedID runwayID, const SGGeod &aThreshold,
  99                     double aHeading, double aDisplacedThreshold,
 100                     double aStopway);
 101
 102   PositionedID insertNavaid(FGPositioned::Type ty, const std::string& ident,
 103                             const std::string& name, const SGGeod& pos, int freq, int range, double multiuse,
 104                             PositionedID apt, PositionedID runway);
 105   void updateILS(PositionedID ils, const SGGeod& newPos, double aHdg);
 106
 107   PositionedID insertCommStation(FGPositioned::Type ty,
 108                                  const std::string& name, const SGGeod& pos, int freq, int range,
 109                                 PositionedID apt);
 110   PositionedID insertFix(const std::string& ident, const SGGeod& aPos);
 111
 112   PositionedID createUserWaypoint(const std::string& ident, const SGGeod& aPos);
 113
 114   void setAirportMetar(const std::string& icao, bool hasMetar);
 115
 116   void updatePosition(PositionedID item, const SGGeod &pos);
 117
 118   FGPositioned::List findAllWithIdent(const std::string& ident,
 119                                       FGPositioned::Filter* filter, bool exact);
 120   FGPositioned::List findAllWithName(const std::string& ident,
 121                                       FGPositioned::Filter* filter, bool exact);
 122
 123   FGPositionedRef findClosestWithIdent(const std::string& aIdent,
 124                                       const SGGeod& aPos, FGPositioned::Filter* aFilter);
 125
 126
 127   char** searchAirportNamesAndIdents(const std::string& aFilter);
 128
 129   FGPositionedRef findCommByFreq(int freqKhz, const SGGeod& pos, FGPositioned::Filter* filt);
 130
 131   PositionedIDVec airportItemsOfType(PositionedID apt, FGPositioned::Type ty,
 132                                      FGPositioned::Type maxTy = FGPositioned::INVALID);
 133
 134   PositionedID airportItemWithIdent(PositionedID apt, FGPositioned::Type ty, const std::string& ident);
 135
 136   PositionedIDVec findNavaidsByFreq(int freqKhz, const SGGeod& pos, FGPositioned::Filter* filt);
 137
 138   /// overload version of the above that does not consider positioned when
 139   /// returning results. Only used by TACAN carrier search
 140   PositionedIDVec findNavaidsByFreq(int freqKhz, FGPositioned::Filter* filt);
 141
 142   /**
 143    * given a navaid name (or similar) from apt.dat / nav.dat, find the
 144    * corresponding airport and runway IDs.
 145    * Such names look like: 'LHBP 31L DME-ILS' or 'UEEE 23L MM'
 146    */
 147   AirportRunwayPair findAirportRunway(const std::string& name);
 148
 149   /**
 150    * Given an aiport, and runway and ILS identifier, find the corresponding cache
 151    * entry. This matches the data we get in the ils.xml files for airports.
 152    */
 153   PositionedID findILS(PositionedID airport, const std::string& runway, const std::string& navIdent);
 154
 155   /**
 156    * Given an Octree node ID, return a bit-mask defining which of the child
 157    * nodes exist. In practice this means an 8-bit value be sufficent, but
 158    * an int works fine too.
 159    */
 160   int getOctreeBranchChildren(int64_t octreeNodeId);
 161
 162   void defineOctreeNode(Octree::Branch* pr, Octree::Node* nd);
 163
 164   /**
 165    * given an octree leaf, return all its child positioned items and their types
 166    */
 167   TypedPositionedVec getOctreeLeafChildren(int64_t octreeNodeId);
 168
 169 // airways
 170   int findAirway(int network, const std::string& aName);
 171
 172   void insertEdge(int network, int airwayID, PositionedID from, PositionedID to);
 173
 174   bool isInAirwayNetwork(int network, PositionedID pos);
 175
 176   /**
 177    * retrive all the destination points reachcable from a positioned
 178    * in an airway
 179    */
 180   AirwayEdgeVec airwayEdgesFrom(int network, PositionedID pos);
 181 private:
 182   NavDataCache();
 183
 184   class NavDataCachePrivate;
 185   std::auto_ptr<NavDataCachePrivate> d;
 186 };
 187
 188 } // of namespace flightgear
 189
 190 #endif // of FG_NAVDATACACHE_HXX
 191