src/Airports/airport.hxx

   1 // airport.hxx -- a really simplistic class to manage airport ID,
   2 //                 lat, lon of the center of one of it's runways, and
   3 //                 elevation in feet.
   4 //
   5 // Written by Curtis Olson, started April 1998.
   6 // Updated by Durk Talsma, started December 2004.
   7 //
   8 // Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
   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 // $Id$
  25
  26
  27 #ifndef _FG_SIMPLE_HXX
  28 #define _FG_SIMPLE_HXX
  29
  30 #include <simgear/compiler.h>
  31
  32 #include <string>
  33 #include <vector>
  34 #include <map>
  35
  36 #include <Navaids/positioned.hxx>
  37 #include <Navaids/procedure.hxx>
  38
  39 #include "airports_fwd.hxx"
  40 #include "runways.hxx"
  41
  42 /***************************************************************************************
  43  *
  44  **************************************************************************************/
  45 class FGAirport : public FGPositioned
  46 {
  47   public:
  48     FGAirport(PositionedID aGuid, const std::string& id, const SGGeod& location,
  49             const std::string& name, bool has_metar, Type aType);
  50     ~FGAirport();
  51
  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(); }
  55
  56     double getLongitude() const { return longitude(); }
  57     // Returns degrees
  58     double getLatitude()  const { return latitude(); }
  59     // Returns ft
  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;
  65
  66     static bool isAirportType(FGPositioned* pos);
  67
  68     virtual const std::string& name() const
  69     { return _name; }
  70
  71     /**
  72      * reload the ILS data from XML if required.
  73      * @result true if the data was refreshed, false if no data was loaded
  74      * or previously cached data is still correct.
  75      */
  76     bool validateILSData();
  77
  78     SGGeod getTowerLocation() const;
  79
  80     void setMetar(bool value) { _has_metar = value; }
  81
  82     FGRunwayRef getActiveRunwayForUsage() const;
  83
  84     FGAirportDynamics *getDynamics();
  85
  86     unsigned int numRunways() const;
  87     unsigned int numHelipads() const;
  88     FGRunwayRef getRunwayByIndex(unsigned int aIndex) const;
  89     FGHelipadRef getHelipadByIndex(unsigned int aIndex) const;
  90     FGRunwayMap getRunwayMap() const;
  91     FGHelipadMap getHelipadMap() const;
  92
  93     bool hasRunwayWithIdent(const std::string& aIdent) const;
  94     bool hasHelipadWithIdent(const std::string& aIdent) const;
  95     FGRunwayRef getRunwayByIdent(const std::string& aIdent) const;
  96     FGHelipadRef getHelipadByIdent(const std::string& aIdent) const;
  97
  98     struct FindBestRunwayForHeadingParams {
  99       FindBestRunwayForHeadingParams() {
 100         lengthWeight =  0.01;
 101         widthWeight =  0.01;
 102         surfaceWeight =  10;
 103         deviationWeight =  1;
 104         ilsWeight = 0;
 105       }
 106       double lengthWeight;
 107       double widthWeight;
 108       double surfaceWeight;
 109       double deviationWeight;
 110       double ilsWeight;
 111     };
 112     FGRunwayRef findBestRunwayForHeading(double aHeading, struct FindBestRunwayForHeadingParams * parms = NULL ) const;
 113
 114     /**
 115      * return the most likely target runway based on a position.
 116      * Specifically, return the runway for which the course from aPos
 117      * to the runway end, mostly closely matches the runway heading.
 118      * This is a good approximation of which runway the position is on or
 119      * aiming towards.
 120      */
 121     FGRunwayRef findBestRunwayForPos(const SGGeod& aPos) const;
 122
 123     /**
 124      * Retrieve all runways at the airport, but excluding the reciprocal
 125      * runways. For example at KSFO this might return 1L, 1R, 28L and 28R,
 126      * but would not then include 19L/R or 10L/R.
 127      *
 128      * Exactly which runways you get, is undefined (i.e, dont assumes it's
 129      * runways with heading < 180 degrees) - it depends on order in apt.dat.
 130      *
 131      * This is useful for code that wants to process each piece of tarmac at
 132      * an airport *once*, not *twice* - eg mapping and nav-display code.
 133      */
 134     FGRunwayList getRunwaysWithoutReciprocals() const;
 135
 136      /**
 137      * Useful predicate for FMS/GPS/NAV displays and similar - check if this
 138      * aiport has a hard-surfaced runway of at least the specified length.
 139      */
 140     bool hasHardRunwayOfLengthFt(double aLengthFt) const;
 141
 142     unsigned int numTaxiways() const;
 143     FGTaxiwayRef getTaxiwayByIndex(unsigned int aIndex) const;
 144     FGTaxiwayList getTaxiways() const;
 145
 146     unsigned int numPavements() const;
 147     FGPavementRef getPavementByIndex(unsigned int aIndex) const;
 148     FGPavementList getPavements() const;
 149
 150     class AirportFilter : public Filter
 151     {
 152       public:
 153         virtual bool pass(FGPositioned* aPos) const {
 154           return passAirport(static_cast<FGAirport*>(aPos));
 155         }
 156
 157         virtual Type minType() const {
 158           return AIRPORT;
 159         }
 160
 161         virtual Type maxType() const {
 162           return AIRPORT;
 163         }
 164
 165         virtual bool passAirport(FGAirport* aApt) const {
 166           return true;
 167         }
 168      };
 169
 170      /**
 171       * Filter which passes heliports and seaports in addition to airports
 172       */
 173      class PortsFilter : public AirportFilter
 174      {
 175      public:
 176        virtual Type maxType() const {
 177          return SEAPORT;
 178        }
 179      };
 180
 181      class HardSurfaceFilter : public AirportFilter
 182      {
 183      public:
 184        HardSurfaceFilter(double minLengthFt = -1);
 185
 186        virtual bool passAirport(FGAirport* aApt) const;
 187
 188      private:
 189        double mMinLengthFt;
 190      };
 191
 192      /**
 193       * Filter which passes specified port type and in case of airport checks
 194       * if a runway larger the /sim/navdb/min-runway-lenght-ft exists.
 195       */
 196      class TypeRunwayFilter:
 197        public AirportFilter
 198      {
 199        public:
 200          TypeRunwayFilter();
 201
 202          /**
 203           * Construct from string containing type (airport, seaport or heliport)
 204           */
 205          bool fromTypeString(const std::string& type);
 206
 207          virtual FGPositioned::Type minType() const { return _type; }
 208          virtual FGPositioned::Type maxType() const { return _type; }
 209          virtual bool pass(FGPositioned* pos) const;
 210
 211        protected:
 212          FGPositioned::Type _type;
 213          double _min_runway_length_ft;
 214      };
 215
 216
 217      void setProcedures(const std::vector<flightgear::SID*>& aSids,
 218       const std::vector<flightgear::STAR*>& aStars,
 219       const std::vector<flightgear::Approach*>& aApproaches);
 220
 221      void addSID(flightgear::SID* aSid);
 222       void addSTAR(flightgear::STAR* aStar);
 223       void addApproach(flightgear::Approach* aApp);
 224
 225       unsigned int numSIDs() const;
 226       flightgear::SID* getSIDByIndex(unsigned int aIndex) const;
 227       flightgear::SID* findSIDWithIdent(const std::string& aIdent) const;
 228       flightgear::SIDList getSIDs() const;
 229
 230       unsigned int numSTARs() const;
 231       flightgear::STAR* getSTARByIndex(unsigned int aIndex) const;
 232       flightgear::STAR* findSTARWithIdent(const std::string& aIdent) const;
 233       flightgear::STARList getSTARs() const;
 234
 235       unsigned int numApproaches() const;
 236       flightgear::Approach* getApproachByIndex(unsigned int aIndex) const;
 237       flightgear::Approach* findApproachWithIdent(const std::string& aIdent) const;
 238       flightgear::ApproachList getApproaches
 239       (
 240         flightgear::ProcedureType type = flightgear::PROCEDURE_INVALID
 241       ) const;
 242
 243      /**
 244       * Syntactic wrapper around FGPositioned::findClosest - find the closest
 245       * match for filter, and return it cast to FGAirport. The default filter
 246       * passes airports, but not seaports or heliports
 247       */
 248      static FGAirportRef findClosest(const SGGeod& aPos, double aCuttofNm, Filter* filter = NULL);
 249
 250      /**
 251       * Helper to look up an FGAirport instance by unique ident. Throws an
 252       * exception if the airport could not be found - so callers can assume
 253       * the result is non-NULL.
 254       */
 255      static FGAirportRef getByIdent(const std::string& aIdent);
 256
 257      /**
 258       * Helper to look up an FGAirport instance by unique ident. Returns NULL
 259       * if the airport could not be found.
 260       */
 261      static FGAirportRef findByIdent(const std::string& aIdent);
 262
 263      /**
 264       * Specialised helper to implement the AirportList dialog. Performs a
 265       * case-insensitive search on airport names and ICAO codes, and returns
 266       * matches in a format suitable for use by a puaList.
 267       */
 268      static char** searchNamesAndIdents(const std::string& aFilter);
 269
 270
 271     /**
 272      * Sort an FGPositionedList of airports by size (number of runways + length)
 273      * this is meant to prioritise more important airports.
 274      */
 275     static void sortBySize(FGPositionedList&);
 276
 277     flightgear::CommStationList commStationsOfType(FGPositioned::Type aTy) const;
 278
 279     flightgear::CommStationList commStations() const;
 280 private:
 281     static flightgear::AirportCache airportCache;
 282
 283     // disable these
 284     FGAirport operator=(FGAirport &other);
 285     FGAirport(const FGAirport&);
 286
 287     /**
 288      * helper to read airport data from the scenery XML files.
 289      */
 290     void loadSceneryDefinitions() const;
 291
 292     /**
 293      * Helpers to process property data loaded from an ICAO.threshold.xml file
 294      */
 295     void readThresholdData(SGPropertyNode* aRoot);
 296     void processThreshold(SGPropertyNode* aThreshold);
 297
 298     void readILSData(SGPropertyNode* aRoot);
 299
 300     void validateTowerData() const;
 301
 302     /**
 303      * Helper to parse property data loaded from an ICAO.twr.xml file
 304      */
 305     void readTowerData(SGPropertyNode* aRoot);
 306
 307     std::string _name;
 308     bool _has_metar;
 309     FGAirportDynamics *_dynamics;
 310
 311     void loadRunways() const;
 312     void loadHelipads() const;
 313     void loadTaxiways() const;
 314     void loadProcedures() const;
 315
 316     mutable bool mTowerDataLoaded;
 317     mutable bool mRunwaysLoaded;
 318     mutable bool mHelipadsLoaded;
 319     mutable bool mTaxiwaysLoaded;
 320     mutable bool mProceduresLoaded;
 321     bool mILSDataLoaded;
 322
 323     mutable PositionedIDVec mRunways;
 324     mutable PositionedIDVec mHelipads;
 325     mutable PositionedIDVec mTaxiways;
 326     PositionedIDVec mPavements;
 327
 328     typedef SGSharedPtr<flightgear::SID> SIDRef;
 329     typedef SGSharedPtr<flightgear::STAR> STARRef;
 330     typedef SGSharedPtr<flightgear::Approach> ApproachRef;
 331
 332     std::vector<SIDRef> mSIDs;
 333     std::vector<STARRef> mSTARs;
 334     std::vector<ApproachRef> mApproaches;
 335   };
 336
 337 // find basic airport location info from airport database
 338 const FGAirport *fgFindAirportID( const std::string& id);
 339
 340 // get airport elevation
 341 double fgGetAirportElev( const std::string& id );
 342
 343 #endif // _FG_SIMPLE_HXX
 344
 345