1 // airport.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>
36 #include <Navaids/positioned.hxx>
37 #include <Navaids/procedure.hxx>
39 #include "airports_fwd.hxx"
40 #include "runways.hxx"
42 /***************************************************************************************
44 **************************************************************************************/
45 class FGAirport : public FGPositioned
48 FGAirport(PositionedID aGuid, const std::string& id, const SGGeod& location,
49 const std::string& name, bool has_metar, Type aType);
52 const std::string& getId() const { return ident(); }
53 const std::string& getName() const { return _name; }
54 std::string toString() const { return "an airport " + ident(); }
56 double getLongitude() const { return longitude(); }
58 double getLatitude() const { return latitude(); }
60 double getElevation() const { return elevation(); }
61 bool getMetar() const { return _has_metar; }
62 bool isAirport() const;
63 bool isSeaport() const;
64 bool isHeliport() const;
66 /// is the airport closed (disused)?
67 /// note at rpesent we look for an [x] in the name, ideally the database
68 /// would explicitly include this
74 static bool isAirportType(FGPositioned* pos);
76 virtual const std::string& name() const
80 * reload the ILS data from XML if required.
82 void validateILSData();
84 bool hasTower() const;
86 SGGeod getTowerLocation() const;
88 void setMetar(bool value) { _has_metar = value; }
90 FGRunwayRef getActiveRunwayForUsage() const;
92 FGAirportDynamics *getDynamics();
94 unsigned int numRunways() const;
95 unsigned int numHelipads() const;
96 FGRunwayRef getRunwayByIndex(unsigned int aIndex) const;
97 FGHelipadRef getHelipadByIndex(unsigned int aIndex) const;
98 FGRunwayMap getRunwayMap() const;
99 FGHelipadMap getHelipadMap() const;
101 bool hasRunwayWithIdent(const std::string& aIdent) const;
102 bool hasHelipadWithIdent(const std::string& aIdent) const;
103 FGRunwayRef getRunwayByIdent(const std::string& aIdent) const;
104 FGHelipadRef getHelipadByIdent(const std::string& aIdent) const;
106 struct FindBestRunwayForHeadingParams {
107 FindBestRunwayForHeadingParams() {
116 double surfaceWeight;
117 double deviationWeight;
120 FGRunwayRef findBestRunwayForHeading(double aHeading, struct FindBestRunwayForHeadingParams * parms = NULL ) const;
123 * return the most likely target runway based on a position.
124 * Specifically, return the runway for which the course from aPos
125 * to the runway end, mostly closely matches the runway heading.
126 * This is a good approximation of which runway the position is on or
129 FGRunwayRef findBestRunwayForPos(const SGGeod& aPos) const;
132 * Retrieve all runways at the airport, but excluding the reciprocal
133 * runways. For example at KSFO this might return 1L, 1R, 28L and 28R,
134 * but would not then include 19L/R or 10L/R.
136 * Exactly which runways you get, is undefined (i.e, dont assumes it's
137 * runways with heading < 180 degrees) - it depends on order in apt.dat.
139 * This is useful for code that wants to process each piece of tarmac at
140 * an airport *once*, not *twice* - eg mapping and nav-display code.
142 FGRunwayList getRunwaysWithoutReciprocals() const;
145 * Retrieve all runways at the airport
147 FGRunwayList getRunways() const;
150 * Useful predicate for FMS/GPS/NAV displays and similar - check if this
151 * aiport has a hard-surfaced runway of at least the specified length.
153 bool hasHardRunwayOfLengthFt(double aLengthFt) const;
155 FGRunwayRef longestRunway() const;
157 unsigned int numTaxiways() const;
158 FGTaxiwayRef getTaxiwayByIndex(unsigned int aIndex) const;
159 FGTaxiwayList getTaxiways() const;
161 unsigned int numPavements() const;
162 FGPavementRef getPavementByIndex(unsigned int aIndex) const;
163 FGPavementList getPavements() const;
165 class AirportFilter : public Filter
168 virtual bool pass(FGPositioned* aPos) const {
169 return passAirport(static_cast<FGAirport*>(aPos));
172 virtual Type minType() const {
176 virtual Type maxType() const {
180 virtual bool passAirport(FGAirport* aApt) const {
186 * Filter which passes heliports and seaports in addition to airports
188 class PortsFilter : public AirportFilter
191 virtual Type maxType() const {
196 class HardSurfaceFilter : public AirportFilter
199 HardSurfaceFilter(double minLengthFt = -1);
201 virtual bool passAirport(FGAirport* aApt) const;
208 * Filter which passes specified port type and in case of airport checks
209 * if a runway larger the /sim/navdb/min-runway-lenght-ft exists.
211 class TypeRunwayFilter:
218 * Construct from string containing type (airport, seaport or heliport)
220 bool fromTypeString(const std::string& type);
222 virtual FGPositioned::Type minType() const { return _type; }
223 virtual FGPositioned::Type maxType() const { return _type; }
224 virtual bool pass(FGPositioned* pos) const;
227 FGPositioned::Type _type;
228 double _min_runway_length_ft;
232 void setProcedures(const std::vector<flightgear::SID*>& aSids,
233 const std::vector<flightgear::STAR*>& aStars,
234 const std::vector<flightgear::Approach*>& aApproaches);
236 void addSID(flightgear::SID* aSid);
237 void addSTAR(flightgear::STAR* aStar);
238 void addApproach(flightgear::Approach* aApp);
240 unsigned int numSIDs() const;
241 flightgear::SID* getSIDByIndex(unsigned int aIndex) const;
242 flightgear::SID* findSIDWithIdent(const std::string& aIdent) const;
243 flightgear::SIDList getSIDs() const;
245 unsigned int numSTARs() const;
246 flightgear::STAR* getSTARByIndex(unsigned int aIndex) const;
247 flightgear::STAR* findSTARWithIdent(const std::string& aIdent) const;
248 flightgear::STARList getSTARs() const;
250 unsigned int numApproaches() const;
251 flightgear::Approach* getApproachByIndex(unsigned int aIndex) const;
252 flightgear::Approach* findApproachWithIdent(const std::string& aIdent) const;
253 flightgear::ApproachList getApproaches
255 flightgear::ProcedureType type = flightgear::PROCEDURE_INVALID
259 * Syntactic wrapper around FGPositioned::findClosest - find the closest
260 * match for filter, and return it cast to FGAirport. The default filter
261 * passes airports, but not seaports or heliports
263 static FGAirportRef findClosest(const SGGeod& aPos, double aCuttofNm, Filter* filter = NULL);
266 * Helper to look up an FGAirport instance by unique ident. Throws an
267 * exception if the airport could not be found - so callers can assume
268 * the result is non-NULL.
270 static FGAirportRef getByIdent(const std::string& aIdent);
273 * Helper to look up an FGAirport instance by unique ident. Returns NULL
274 * if the airport could not be found.
276 static FGAirportRef findByIdent(const std::string& aIdent);
279 * Specialised helper to implement the AirportList dialog. Performs a
280 * case-insensitive search on airport names and ICAO codes, and returns
281 * matches in a format suitable for use by a puaList.
283 static char** searchNamesAndIdents(const std::string& aFilter);
287 * Sort an FGPositionedList of airports by size (number of runways + length)
288 * this is meant to prioritise more important airports.
290 static void sortBySize(FGPositionedList&);
292 flightgear::CommStationList commStationsOfType(FGPositioned::Type aTy) const;
294 flightgear::CommStationList commStations() const;
296 static flightgear::AirportCache airportCache;
299 FGAirport operator=(FGAirport &other);
300 FGAirport(const FGAirport&);
303 * helper to read airport data from the scenery XML files.
305 void loadSceneryDefinitions() const;
308 * Helpers to process property data loaded from an ICAO.threshold.xml file
310 void readThresholdData(SGPropertyNode* aRoot);
311 void processThreshold(SGPropertyNode* aThreshold);
313 void readILSData(SGPropertyNode* aRoot);
315 void validateTowerData() const;
318 * Helper to parse property data loaded from an ICAO.twr.xml file
320 void readTowerData(SGPropertyNode* aRoot);
322 PositionedIDVec itemsOfType(FGPositioned::Type ty) const;
326 FGAirportDynamics *_dynamics;
328 void loadRunways() const;
329 void loadHelipads() const;
330 void loadTaxiways() const;
331 void loadProcedures() const;
333 mutable bool mTowerDataLoaded;
334 mutable bool mHasTower;
335 mutable SGGeod mTowerPosition;
337 mutable bool mRunwaysLoaded;
338 mutable bool mHelipadsLoaded;
339 mutable bool mTaxiwaysLoaded;
340 mutable bool mProceduresLoaded;
342 mutable bool mThresholdDataLoaded;
345 mutable std::vector<FGRunwayRef> mRunways;
347 mutable PositionedIDVec mHelipads;
348 mutable PositionedIDVec mTaxiways;
349 PositionedIDVec mPavements;
351 typedef SGSharedPtr<flightgear::SID> SIDRef;
352 typedef SGSharedPtr<flightgear::STAR> STARRef;
353 typedef SGSharedPtr<flightgear::Approach> ApproachRef;
355 std::vector<SIDRef> mSIDs;
356 std::vector<STARRef> mSTARs;
357 std::vector<ApproachRef> mApproaches;
360 // find basic airport location info from airport database
361 const FGAirport *fgFindAirportID( const std::string& id);
363 // get airport elevation
364 double fgGetAirportElev( const std::string& id );
366 #endif // _FG_SIMPLE_HXX