src/Airports/simple.hxx

   1 // simple.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 <map>
  34 #include <set>
  35 #include <vector>
  36
  37 #include <simgear/math/point3d.hxx>
  38 #include "Navaids/positioned.hxx"
  39
  40 // forward decls
  41 class FGAirportDynamics;
  42 class FGRunway;
  43
  44 typedef SGSharedPtr<FGRunway> FGRunwayPtr;
  45
  46 /***************************************************************************************
  47  *
  48  **************************************************************************************/
  49 class FGAirport : public FGPositioned
  50 {
  51 private:
  52     SGGeod _tower_location;
  53     std::string _name;
  54     bool _has_metar;
  55     FGAirportDynamics *_dynamics;
  56
  57 public:
  58     FGAirport(const std::string& id, const SGGeod& location, const SGGeod& tower,
  59             const std::string& name, bool has_metar, Type aType);
  60     ~FGAirport();
  61
  62     const std::string& getId() const { return ident(); }
  63     const std::string& getName() const { return _name; }
  64     double getLongitude() const { return longitude(); }
  65     // Returns degrees
  66     double getLatitude()  const { return latitude(); }
  67     // Returns ft
  68     double getElevation() const { return elevation(); }
  69     bool   getMetar()     const { return _has_metar; }
  70     bool   isAirport()    const;
  71     bool   isSeaport()    const;
  72     bool   isHeliport()   const;
  73
  74     const SGGeod& getTowerLocation() const { return _tower_location; }
  75
  76     void setMetar(bool value) { _has_metar = value; }
  77
  78     FGRunway* getActiveRunwayForUsage() const;
  79
  80     FGAirportDynamics *getDynamics();
  81
  82     unsigned int numRunways() const;
  83     FGRunway* getRunwayByIndex(unsigned int aIndex) const;
  84
  85     bool hasRunwayWithIdent(const std::string& aIdent) const;
  86     FGRunway* getRunwayByIdent(const std::string& aIdent) const;
  87     FGRunway* findBestRunwayForHeading(double aHeading) const;
  88
  89      /**
  90      * Useful predicate for FMS/GPS/NAV displays and similar - check if this
  91      * aiport has a hard-surfaced runway of at least the specified length.
  92      */
  93     bool hasHardRunwayOfLengthFt(double aLengthFt) const;
  94
  95     unsigned int numTaxiways() const;
  96     FGRunway* getTaxiwayByIndex(unsigned int aIndex) const;
  97
  98     void addRunway(FGRunway* aRunway);
  99
 100     class AirportFilter : public Filter
 101      {
 102      public:
 103        virtual bool pass(FGPositioned* aPos) const {
 104          Type ty(aPos->type());
 105          return (ty >= AIRPORT) && (ty <= SEAPORT);
 106        }
 107      };
 108
 109      class HardSurfaceFilter : public Filter
 110      {
 111      public:
 112        HardSurfaceFilter(double minLengthFt);
 113
 114        virtual bool pass(FGPositioned* aPos) const;
 115      private:
 116        double mMinLengthFt;
 117      };
 118
 119      /**
 120       * Syntactic wrapper around FGPositioned::findClosest - find the closest
 121       * match for filter, and return it cast to FGAirport. The default filter
 122       * passes all airports, including seaports and heliports.
 123       */
 124      static FGAirport* findClosest(const SGGeod& aPos, double aCuttofNm, Filter* filter = NULL);
 125 private:
 126     typedef std::vector<FGRunwayPtr>::const_iterator Runway_iterator;
 127     /**
 128      * Helper to locate a runway by ident
 129      */
 130     Runway_iterator getIteratorForRunwayIdent(const std::string& aIdent) const;
 131
 132     FGAirport operator=(FGAirport &other);
 133     FGAirport(const FGAirport&);
 134
 135     std::vector<FGRunwayPtr> mRunways;
 136     std::vector<FGRunwayPtr> mTaxiways;
 137 };
 138
 139
 140 class FGAirportSearchFilter {
 141 public:
 142     virtual ~FGAirportSearchFilter() {}
 143     // all airports pass the filter by default
 144     virtual bool pass(FGAirport*) { return true; }
 145 };
 146
 147 typedef std::map < std::string, FGAirport* > airport_map;
 148 typedef airport_map::iterator airport_map_iterator;
 149 typedef airport_map::const_iterator const_airport_map_iterator;
 150
 151 typedef std::vector < FGAirport * > airport_list;
 152 typedef airport_list::iterator airport_list_iterator;
 153 typedef airport_list::const_iterator const_airport_list_iterator;
 154
 155
 156
 157 class FGAirportList {
 158 private:
 159
 160     airport_map airports_by_id;
 161     airport_list airports_array;
 162
 163 public:
 164     // Constructor (new)
 165     FGAirportList();
 166
 167     // Destructor
 168     ~FGAirportList();
 169
 170     // add an entry to the list
 171     FGAirport* add( const std::string& id, const SGGeod& location, const SGGeod& tower,
 172               const std::string& name, bool has_metar, FGPositioned::Type aType);
 173
 174     // search for the specified id.
 175     // Returns NULL if unsucessfull.
 176     FGAirport* search( const std::string& id );
 177
 178     // search for the airport closest to the specified position
 179     // (currently a linear inefficient search so it's probably not
 180     // best to use this at runtime.)  An FGAirportSearchFilter class
 181     // can be used to restrict the possible choices to a subtype.
 182     // max_range limits search - specified as an arc distance, in degrees
 183     FGAirport* search( double lon_deg, double lat_deg, double max_range );
 184     FGAirport* search( double lon_deg, double lat_deg, double max_range, FGAirportSearchFilter& );
 185
 186     /**
 187      * Return the number of airports in the list.
 188      */
 189     int size() const;
 190
 191     /**
 192      * Return a specific airport, by position.
 193      */
 194     const FGAirport *getAirport( unsigned int index ) const;
 195
 196     /**
 197      * Mark the specified airport record as not having metar
 198      */
 199     void no_metar( const std::string &id );
 200
 201     /**
 202      * Mark the specified airport record as (yes) having metar
 203      */
 204     void has_metar( const std::string &id );
 205
 206 };
 207
 208 // find basic airport location info from airport database
 209 const FGAirport *fgFindAirportID( const std::string& id);
 210
 211 // get airport elevation
 212 double fgGetAirportElev( const std::string& id );
 213
 214 // get airport position
 215 Point3D fgGetAirportPos( const std::string& id );
 216
 217 #endif // _FG_SIMPLE_HXX
 218
 219