1 // simple.hxx -- a really simplistic class to manage airport ID,
2 // lat, lon of the center of one of it's runways, and
5 // Written by Curtis Olson, started April 1998.
6 // Updated by Durk Talsma, started December 2004.
8 // Copyright (C) 1998 Curtis L. Olson - http://www.flightgear.org/~curt
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.
27 #ifndef _FG_SIMPLE_HXX
28 #define _FG_SIMPLE_HXX
30 #include <simgear/compiler.h>
35 #include <Navaids/positioned.hxx>
38 class FGAirportDynamics;
44 typedef SGSharedPtr<FGRunway> FGRunwayPtr;
45 typedef SGSharedPtr<FGTaxiway> FGTaxiwayPtr;
46 typedef SGSharedPtr<FGPavement> FGPavementPtr;
48 namespace flightgear {
55 typedef SGSharedPtr<Waypt> WayptRef;
56 typedef std::vector<WayptRef> WayptVec;
61 /***************************************************************************************
63 **************************************************************************************/
64 class FGAirport : public FGPositioned
67 FGAirport(const std::string& id, const SGGeod& location, const SGGeod& tower,
68 const std::string& name, bool has_metar, Type aType);
71 const std::string& getId() const { return ident(); }
72 const std::string& getName() const { return _name; }
73 double getLongitude() const { return longitude(); }
75 double getLatitude() const { return latitude(); }
77 double getElevation() const { return elevation(); }
78 bool getMetar() const { return _has_metar; }
79 bool isAirport() const;
80 bool isSeaport() const;
81 bool isHeliport() const;
83 virtual const std::string& name() const
86 const SGGeod& getTowerLocation() const { return _tower_location; }
88 void setMetar(bool value) { _has_metar = value; }
90 FGRunway* getActiveRunwayForUsage() const;
92 FGAirportDynamics *getDynamics();
94 unsigned int numRunways() const;
95 FGRunway* getRunwayByIndex(unsigned int aIndex) const;
97 bool hasRunwayWithIdent(const std::string& aIdent) const;
98 FGRunway* getRunwayByIdent(const std::string& aIdent) const;
99 FGRunway* findBestRunwayForHeading(double aHeading) const;
102 * return the most likely target runway based on a position.
103 * Specifically, return the runway for which the course from aPos
104 * to the runway end, mostly closely matches the runway heading.
105 * This is a good approximation of which runway the position is on or
108 FGRunway* findBestRunwayForPos(const SGGeod& aPos) const;
111 * Useful predicate for FMS/GPS/NAV displays and similar - check if this
112 * aiport has a hard-surfaced runway of at least the specified length.
114 bool hasHardRunwayOfLengthFt(double aLengthFt) const;
116 unsigned int numTaxiways() const;
117 FGTaxiway* getTaxiwayByIndex(unsigned int aIndex) const;
119 unsigned int numPavements() const;
120 FGPavement* getPavementByIndex(unsigned int aIndex) const;
122 void setRunwaysAndTaxiways(std::vector<FGRunwayPtr>& rwys,
123 std::vector<FGTaxiwayPtr>& txwys,
124 std::vector<FGPavementPtr>& pvts);
126 class AirportFilter : public Filter
129 virtual bool pass(FGPositioned* aPos) const {
130 return passAirport(static_cast<FGAirport*>(aPos));
133 virtual Type minType() const {
137 virtual Type maxType() const {
141 virtual bool passAirport(FGAirport* aApt) const {
147 * Filter which passes heliports and seaports in addition to airports
149 class PortsFilter : public AirportFilter
152 virtual Type maxType() const {
157 class HardSurfaceFilter : public AirportFilter
160 HardSurfaceFilter(double minLengthFt);
162 virtual bool passAirport(FGAirport* aApt) const;
169 void setProcedures(const std::vector<flightgear::SID*>& aSids,
170 const std::vector<flightgear::STAR*>& aStars,
171 const std::vector<flightgear::Approach*>& aApproaches);
173 void addSID(flightgear::SID* aSid);
174 void addSTAR(flightgear::STAR* aStar);
175 void addApproach(flightgear::Approach* aApp);
177 unsigned int numSIDs() const;
178 flightgear::SID* getSIDByIndex(unsigned int aIndex) const;
179 flightgear::SID* findSIDWithIdent(const std::string& aIdent) const;
181 unsigned int numSTARs() const;
182 flightgear::STAR* getSTARByIndex(unsigned int aIndex) const;
183 flightgear::STAR* findSTARWithIdent(const std::string& aIdent) const;
185 unsigned int numApproaches() const;
186 flightgear::Approach* getApproachByIndex(unsigned int aIndex) const;
189 * Syntactic wrapper around FGPositioned::findClosest - find the closest
190 * match for filter, and return it cast to FGAirport. The default filter
191 * passes airports, but not seaports or heliports
193 static FGAirport* findClosest(const SGGeod& aPos, double aCuttofNm, Filter* filter = NULL);
196 * Helper to look up an FGAirport instance by unique ident. Throws an
197 * exception if the airport could not be found - so callers can assume
198 * the result is non-NULL.
200 static FGAirport* getByIdent(const std::string& aIdent);
203 * Helper to look up an FGAirport instance by unique ident. Returns NULL
204 * if the airport could not be found.
206 static FGAirport* findByIdent(const std::string& aIdent);
209 * Specialised helper to implement the AirportList dialog. Performs a
210 * case-insensitive search on airport names and ICAO codes, and returns
211 * matches in a format suitable for use by a puaList.
213 static char** searchNamesAndIdents(const std::string& aFilter);
215 bool buildApproach(flightgear::Waypt* aEnroute, flightgear::STAR* aSTAR,
216 FGRunway* aRwy, flightgear::WayptVec& aRoute);
219 * Given a destiation point, select the best SID and transition waypt from
220 * this airport. Returns (NULL,NULL) is no SIDs are defined, otherwise the
221 * best SID/transition is that which is closest to the destination point.
223 std::pair<flightgear::SID*, flightgear::WayptRef> selectSID(const SGGeod& aDest, FGRunway* aRwy);
226 * Select a STAR and enroute transition waypt, given an origin (departure) position.
227 * returns (NULL, NULL) is no suitable STAR is exists
229 std::pair<flightgear::STAR*, flightgear::WayptRef> selectSTAR(const SGGeod& aOrigin, FGRunway* aRwy);
232 typedef std::vector<FGRunwayPtr>::const_iterator Runway_iterator;
234 * Helper to locate a runway by ident
236 Runway_iterator getIteratorForRunwayIdent(const std::string& aIdent) const;
239 FGAirport operator=(FGAirport &other);
240 FGAirport(const FGAirport&);
243 * helper to read airport data from the scenery XML files.
245 void loadSceneryDefinitions() const;
248 * Helpers to process property data loaded from an ICAO.threshold.xml file
250 void readThresholdData(SGPropertyNode* aRoot);
251 void processThreshold(SGPropertyNode* aThreshold);
254 * Helper to parse property data loaded from an ICAO.twr.xml filke
256 void readTowerData(SGPropertyNode* aRoot);
258 SGGeod _tower_location;
261 FGAirportDynamics *_dynamics;
263 void loadRunways() const;
264 void loadTaxiways() const;
265 void loadProcedures() const;
267 mutable bool mRunwaysLoaded;
268 mutable bool mTaxiwaysLoaded;
269 mutable bool mProceduresLoaded;
271 std::vector<FGRunwayPtr> mRunways;
272 std::vector<FGTaxiwayPtr> mTaxiways;
273 std::vector<FGPavementPtr> mPavements;
275 std::vector<flightgear::SID*> mSIDs;
276 std::vector<flightgear::STAR*> mSTARs;
277 std::vector<flightgear::Approach*> mApproaches;
280 // find basic airport location info from airport database
281 const FGAirport *fgFindAirportID( const std::string& id);
283 // get airport elevation
284 double fgGetAirportElev( const std::string& id );
286 #endif // _FG_SIMPLE_HXX