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