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 class FGRunway;
  34
  35 namespace flightgear
  36 {
  37
  38 /// a pair of airport ID, runway ID
  39 typedef std::pair<PositionedID, PositionedID> AirportRunwayPair;
  40
  41 typedef std::pair<FGPositioned::Type, PositionedID> TypedPositioned;
  42 typedef std::vector<TypedPositioned> TypedPositionedVec;
  43
  44 // pair of airway ID, destination node ID
  45 typedef std::pair<int, PositionedID> AirwayEdge;
  46 typedef std::vector<AirwayEdge> AirwayEdgeVec;
  47
  48 namespace Octree {
  49   class Node;
  50   class Branch;
  51 }
  52
  53 class NavDataCache
  54 {
  55 public:
  56     ~NavDataCache();
  57
  58 // singleton accessor
  59     static NavDataCache* instance();
  60
  61   /**
  62    * predicate - check if the cache needs to be rebuilt.
  63    * This can happen is the cache file is missing or damaged, or one of the
  64    ** global input files is changed.
  65    */
  66   bool isRebuildRequired();
  67
  68   /**
  69    * run the cache rebuild - returns true if rebuild is complete,
  70    * otherwise keep going.
  71    */
  72   bool rebuild();
  73
  74   bool isCachedFileModified(const SGPath& path) const;
  75   void stampCacheFile(const SGPath& path);
  76
  77   int readIntProperty(const std::string& key);
  78   double readDoubleProperty(const std::string& key);
  79   std::string readStringProperty(const std::string& key);
  80
  81   void writeIntProperty(const std::string& key, int value);
  82   void writeStringProperty(const std::string& key, const std::string& value);
  83   void writeDoubleProperty(const std::string& key, const double& value);
  84
  85   string_list readStringListProperty(const std::string& key);
  86   void writeStringListProperty(const std::string& key, const string_list& values);
  87
  88   /**
  89    * retrieve an FGPositioned from the cache.
  90    * This may be trivial if the object is previously loaded, or require actual
  91    * disk IO.
  92    */
  93   FGPositionedRef loadById(PositionedID guid);
  94
  95   PositionedID insertAirport(FGPositioned::Type ty, const std::string& ident,
  96                              const std::string& name);
  97   void insertTower(PositionedID airportId, const SGGeod& pos);
  98   PositionedID insertRunway(FGPositioned::Type ty, const std::string& ident,
  99                           const SGGeod& pos, PositionedID apt,
 100                           double heading, double length, double width, double displacedThreshold,
 101                           double stopway, int surfaceCode);
 102   void setRunwayReciprocal(PositionedID runway, PositionedID recip);
 103   void setRunwayILS(PositionedID runway, PositionedID ils);
 104
 105   PositionedID insertNavaid(FGPositioned::Type ty, const std::string& ident,
 106                             const std::string& name, const SGGeod& pos, int freq, int range, double multiuse,
 107                             PositionedID apt, PositionedID runway);
 108
 109   // Assign colocated DME to a navaid
 110   void setNavaidColocated(PositionedID navaid, PositionedID colocatedDME);
 111
 112   PositionedID insertCommStation(FGPositioned::Type ty,
 113                                  const std::string& name, const SGGeod& pos, int freq, int range,
 114                                 PositionedID apt);
 115   PositionedID insertFix(const std::string& ident, const SGGeod& aPos);
 116
 117   PositionedID createPOI(FGPositioned::Type ty, const std::string& ident, const SGGeod& aPos);
 118
 119   bool removePOI(FGPositioned::Type ty, const std::string& aIdent);
 120
 121   void dropGroundnetFor(PositionedID aAirport);
 122
 123   /**
 124    * Remove all ground-nets globally from the cache.
 125    * This includes parking and taxi-nodes and edges between them. It's useful
 126    * when scenery paths change, since the ground-nets depend on the scenery.
 127    * Using this we can avoid havind to rebuild the entire cache.
 128    */
 129   void dropAllGroundnets();
 130
 131   PositionedID insertParking(const std::string& name, const SGGeod& aPos,
 132                              PositionedID aAirport,
 133                              double aHeading, int aRadius, const std::string& aAircraftType,
 134                              const std::string& aAirlines);
 135
 136   void setParkingPushBackRoute(PositionedID parking, PositionedID pushBackNode);
 137
 138   PositionedID insertTaxiNode(const SGGeod& aPos, PositionedID aAirport, int aHoldType, bool aOnRunway);
 139
 140   void insertGroundnetEdge(PositionedID aAirport, PositionedID from, PositionedID to);
 141
 142   /// update the metar flag associated with an airport
 143   void setAirportMetar(const std::string& icao, bool hasMetar);
 144
 145   /**
 146    * Modify the position of an existing item.
 147    */
 148   void updatePosition(PositionedID item, const SGGeod &pos);
 149
 150   FGPositionedList findAllWithIdent( const std::string& ident,
 151                                      FGPositioned::Filter* filter,
 152                                      bool exact );
 153   FGPositionedList findAllWithName( const std::string& ident,
 154                                     FGPositioned::Filter* filter,
 155                                     bool exact );
 156
 157   FGPositionedRef findClosestWithIdent( const std::string& aIdent,
 158                                         const SGGeod& aPos,
 159                                         FGPositioned::Filter* aFilter );
 160
 161
 162   /**
 163    * Helper to implement the AirportSearch widget. Optimised text search of
 164    * airport names and idents, returning a list suitable for passing directly
 165    * to PLIB.
 166    */
 167   char** searchAirportNamesAndIdents(const std::string& aFilter);
 168
 169   /**
 170    * Find the closest matching comm-station on a frequency, to a position.
 171    * The filter with be used for both type ranging and to validate the result
 172    * candidates.
 173    */
 174   FGPositionedRef findCommByFreq(int freqKhz, const SGGeod& pos, FGPositioned::Filter* filt);
 175
 176   /**
 177    * find all items of a specified type (or range of types) at an airport
 178    */
 179   PositionedIDVec airportItemsOfType(PositionedID apt, FGPositioned::Type ty,
 180                                      FGPositioned::Type maxTy = FGPositioned::INVALID);
 181
 182   /**
 183    * find the first match item of the specified type and ident, at an airport
 184    */
 185   PositionedID airportItemWithIdent(PositionedID apt, FGPositioned::Type ty, const std::string& ident);
 186
 187   /**
 188    * Find all navaids matching a particular frequency, sorted by range from the
 189    * supplied position. Type-range will be determined from the filter
 190    */
 191   PositionedIDVec findNavaidsByFreq(int freqKhz, const SGGeod& pos, FGPositioned::Filter* filt);
 192
 193   /// overload version of the above that does not consider positioned when
 194   /// returning results. Only used by TACAN carrier search
 195   PositionedIDVec findNavaidsByFreq(int freqKhz, FGPositioned::Filter* filt);
 196
 197   /**
 198    * Given a runway and type, find the corresponding navaid (ILS / GS / OM)
 199    */
 200   PositionedID findNavaidForRunway(PositionedID runway, FGPositioned::Type ty);
 201
 202   /**
 203    * given a navaid name (or similar) from apt.dat / nav.dat, find the
 204    * corresponding airport and runway IDs.
 205    * Such names look like: 'LHBP 31L DME-ILS' or 'UEEE 23L MM'
 206    */
 207   AirportRunwayPair findAirportRunway(const std::string& name);
 208
 209   /**
 210    * Given an aiport, and runway and ILS identifier, find the corresponding cache
 211    * entry. This matches the data we get in the ils.xml files for airports.
 212    */
 213   PositionedID findILS(PositionedID airport, const std::string& runway, const std::string& navIdent);
 214
 215   /**
 216    * Given an Octree node ID, return a bit-mask defining which of the child
 217    * nodes exist. In practice this means an 8-bit value be sufficent, but
 218    * an int works fine too.
 219    */
 220   int getOctreeBranchChildren(int64_t octreeNodeId);
 221
 222   void defineOctreeNode(Octree::Branch* pr, Octree::Node* nd);
 223
 224   /**
 225    * given an octree leaf, return all its child positioned items and their types
 226    */
 227   TypedPositionedVec getOctreeLeafChildren(int64_t octreeNodeId);
 228
 229 // airways
 230   int findAirway(int network, const std::string& aName);
 231
 232   /**
 233    * insert an edge between two positioned nodes, into the network.
 234    * The airway identifier will be set accordingly. No reverse edge is created
 235    * by this method - edges are directional so a reverses must be explicitly
 236    * created.
 237    */
 238   void insertEdge(int network, int airwayID, PositionedID from, PositionedID to);
 239
 240   /// is the specified positioned a node on the network?
 241   bool isInAirwayNetwork(int network, PositionedID pos);
 242
 243   /**
 244    * retrive all the destination points reachcable from a positioned
 245    * in an airway
 246    */
 247   AirwayEdgeVec airwayEdgesFrom(int network, PositionedID pos);
 248
 249 // ground-network
 250   PositionedIDVec groundNetNodes(PositionedID aAirport, bool onlyPushback);
 251   void markGroundnetAsPushback(PositionedID nodeId);
 252
 253   PositionedID findGroundNetNode(PositionedID airport, const SGGeod& aPos,
 254                                  bool onRunway, FGRunway* aRunway = NULL);
 255   PositionedIDVec groundNetEdgesFrom(PositionedID pos, bool onlyPushback);
 256
 257   PositionedIDVec findAirportParking(PositionedID airport, const std::string& flightType,
 258                                      int radius);
 259
 260
 261     class Transaction
 262     {
 263     public:
 264         Transaction(NavDataCache* cache);
 265         ~Transaction();
 266
 267         void commit();
 268     private:
 269         NavDataCache* _instance;
 270         bool _committed;
 271     };
 272
 273     bool isReadOnly() const;
 274 private:
 275   NavDataCache();
 276
 277   friend class RebuildThread;
 278   void doRebuild();
 279
 280   friend class Transaction;
 281
 282     void beginTransaction();
 283     void commitTransaction();
 284     void abortTransaction();
 285
 286   class NavDataCachePrivate;
 287   std::auto_ptr<NavDataCachePrivate> d;
 288 };
 289
 290 } // of namespace flightgear
 291
 292 #endif // of FG_NAVDATACACHE_HXX
 293