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