2 * NavDataCache.hxx - defines a unified binary cache for navigation
3 * data, parsed from various text / XML sources.
6 // Written by James Turner, started 2012.
8 // Copyright (C) 2012 James Turner
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.
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.
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.
24 #ifndef FG_NAVDATACACHE_HXX
25 #define FG_NAVDATACACHE_HXX
29 #include <simgear/misc/strutils.hxx> // for string_list
30 #include <Navaids/positioned.hxx>
37 /// a pair of airport ID, runway ID
38 typedef std::pair<PositionedID, PositionedID> AirportRunwayPair;
40 typedef std::pair<FGPositioned::Type, PositionedID> TypedPositioned;
41 typedef std::vector<TypedPositioned> TypedPositionedVec;
43 // pair of airway ID, destination node ID
44 typedef std::pair<int, PositionedID> AirwayEdge;
45 typedef std::vector<AirwayEdge> AirwayEdgeVec;
58 static NavDataCache* instance();
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.
65 bool isRebuildRequired();
68 * run the cache rebuild - returns true if rebuild is complete,
69 * otherwise keep going.
73 bool isCachedFileModified(const SGPath& path) const;
74 void stampCacheFile(const SGPath& path);
76 int readIntProperty(const std::string& key);
77 double readDoubleProperty(const std::string& key);
78 std::string readStringProperty(const std::string& key);
80 void writeIntProperty(const std::string& key, int value);
81 void writeStringProperty(const std::string& key, const std::string& value);
82 void writeDoubleProperty(const std::string& key, const double& value);
84 string_list readStringListProperty(const std::string& key);
85 void writeStringListProperty(const std::string& key, const string_list& values);
87 FGPositioned* loadById(PositionedID guid);
89 PositionedID insertAirport(FGPositioned::Type ty, const std::string& ident,
90 const std::string& name);
91 void insertTower(PositionedID airportId, const SGGeod& pos);
92 PositionedID insertRunway(FGPositioned::Type ty, const std::string& ident,
93 const SGGeod& pos, PositionedID apt,
94 double heading, double length, double width, double displacedThreshold,
95 double stopway, int surfaceCode);
96 void setRunwayReciprocal(PositionedID runway, PositionedID recip);
97 void setRunwayILS(PositionedID runway, PositionedID ils);
99 void updateRunwayThreshold(PositionedID runwayID, const SGGeod &aThreshold,
100 double aHeading, double aDisplacedThreshold,
103 PositionedID insertNavaid(FGPositioned::Type ty, const std::string& ident,
104 const std::string& name, const SGGeod& pos, int freq, int range, double multiuse,
105 PositionedID apt, PositionedID runway);
106 void updateILS(PositionedID ils, const SGGeod& newPos, double aHdg);
108 PositionedID insertCommStation(FGPositioned::Type ty,
109 const std::string& name, const SGGeod& pos, int freq, int range,
111 PositionedID insertFix(const std::string& ident, const SGGeod& aPos);
113 PositionedID createUserWaypoint(const std::string& ident, const SGGeod& aPos);
115 void setAirportMetar(const std::string& icao, bool hasMetar);
117 void updatePosition(PositionedID item, const SGGeod &pos);
119 FGPositioned::List findAllWithIdent(const std::string& ident,
120 FGPositioned::Filter* filter, bool exact);
121 FGPositioned::List findAllWithName(const std::string& ident,
122 FGPositioned::Filter* filter, bool exact);
124 FGPositionedRef findClosestWithIdent(const std::string& aIdent,
125 const SGGeod& aPos, FGPositioned::Filter* aFilter);
128 char** searchAirportNamesAndIdents(const std::string& aFilter);
130 FGPositionedRef findCommByFreq(int freqKhz, const SGGeod& pos, FGPositioned::Filter* filt);
132 PositionedIDVec airportItemsOfType(PositionedID apt, FGPositioned::Type ty,
133 FGPositioned::Type maxTy = FGPositioned::INVALID);
135 PositionedID airportItemWithIdent(PositionedID apt, FGPositioned::Type ty, const std::string& ident);
137 PositionedIDVec findNavaidsByFreq(int freqKhz, const SGGeod& pos, FGPositioned::Filter* filt);
139 /// overload version of the above that does not consider positioned when
140 /// returning results. Only used by TACAN carrier search
141 PositionedIDVec findNavaidsByFreq(int freqKhz, FGPositioned::Filter* filt);
144 * Given a runway and type, find the corresponding navaid (ILS / GS / OM)
146 PositionedID findNavaidForRunway(PositionedID runway, FGPositioned::Type ty);
149 * given a navaid name (or similar) from apt.dat / nav.dat, find the
150 * corresponding airport and runway IDs.
151 * Such names look like: 'LHBP 31L DME-ILS' or 'UEEE 23L MM'
153 AirportRunwayPair findAirportRunway(const std::string& name);
156 * Given an aiport, and runway and ILS identifier, find the corresponding cache
157 * entry. This matches the data we get in the ils.xml files for airports.
159 PositionedID findILS(PositionedID airport, const std::string& runway, const std::string& navIdent);
162 * Given an Octree node ID, return a bit-mask defining which of the child
163 * nodes exist. In practice this means an 8-bit value be sufficent, but
164 * an int works fine too.
166 int getOctreeBranchChildren(int64_t octreeNodeId);
168 void defineOctreeNode(Octree::Branch* pr, Octree::Node* nd);
171 * given an octree leaf, return all its child positioned items and their types
173 TypedPositionedVec getOctreeLeafChildren(int64_t octreeNodeId);
176 int findAirway(int network, const std::string& aName);
178 void insertEdge(int network, int airwayID, PositionedID from, PositionedID to);
180 bool isInAirwayNetwork(int network, PositionedID pos);
183 * retrive all the destination points reachcable from a positioned
186 AirwayEdgeVec airwayEdgesFrom(int network, PositionedID pos);
190 friend class RebuildThread;
193 class NavDataCachePrivate;
194 std::auto_ptr<NavDataCachePrivate> d;
197 } // of namespace flightgear
199 #endif // of FG_NAVDATACACHE_HXX