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
  31 #ifndef __cplusplus
  32 # error This library requires C++
  33 #endif
  34
  35
  36 #ifdef HAVE_CONFIG_H
  37 #  include <config.h>
  38 #endif
  39 #include <simgear/math/point3d.hxx>
  40
  41 #include <simgear/compiler.h>
  42
  43 #include STL_STRING
  44 #include <map>
  45 #include <set>
  46 #include <vector>
  47
  48 #include "runwayprefs.hxx"
  49 #include "parking.hxx"
  50 #include "groundnetwork.hxx"
  51 #include "dynamics.hxx"
  52
  53
  54 SG_USING_STD(string);
  55 SG_USING_STD(map);
  56 SG_USING_STD(set);
  57 SG_USING_STD(vector);
  58
  59
  60
  61
  62 /***************************************************************************************
  63  *
  64  **************************************************************************************/
  65 class FGAirport {
  66 private:
  67     string _id;
  68     double _longitude;    // degrees
  69     double _latitude;     // degrees
  70     double _elevation;    // ft
  71     string _name;
  72     bool _has_metar;
  73     FGAirportDynamics *dynamics;
  74
  75 public:
  76     FGAirport();
  77     // FGAirport(const FGAirport &other);
  78     FGAirport(const string& id, double lon, double lat, double elev, const string& name, bool has_metar);
  79     ~FGAirport();
  80
  81     string getId() const { return _id; }
  82     const string &getName() const { return _name; }
  83     double getLongitude() const { return _longitude; }
  84     // Returns degrees
  85     double getLatitude()  const { return _latitude; }
  86     // Returns ft
  87     double getElevation() const { return _elevation; }
  88     bool   getMetar()     const { return _has_metar; }
  89
  90     void setId(const string& id) { _id = id; }
  91     void setMetar(bool value) { _has_metar = value; }
  92
  93     FGAirportDynamics *getDynamics();
  94
  95 private:
  96     FGAirport operator=(FGAirport &other);
  97     FGAirport(const FGAirport&);
  98 };
  99
 100
 101
 102 typedef map < string, FGAirport* > airport_map;
 103 typedef airport_map::iterator airport_map_iterator;
 104 typedef airport_map::const_iterator const_airport_map_iterator;
 105
 106 typedef vector < FGAirport * > airport_list;
 107 typedef airport_list::iterator airport_list_iterator;
 108 typedef airport_list::const_iterator const_airport_list_iterator;
 109
 110
 111
 112 class FGAirportList {
 113 private:
 114
 115     airport_map airports_by_id;
 116     airport_list airports_array;
 117     //set < string > ai_dirs;
 118
 119 public:
 120     // Constructor (new)
 121     FGAirportList();
 122
 123     // Destructor
 124     ~FGAirportList();
 125
 126     // add an entry to the list
 127     void add( const string& id, const double longitude, const double latitude,
 128               const double elevation, const string& name, const bool has_metar );
 129
 130     // search for the specified id.
 131     // Returns NULL if unsucessfull.
 132     FGAirport* search( const string& id );
 133
 134     // Search for the next airport in ASCII sequence to the supplied id.
 135     // eg. id = "KDC" or "KDCA" would both return "KDCA".
 136     // If exact = true then only exact matches are returned.
 137     // NOTE: Numbers come prior to A-Z in ASCII sequence so id = "LD" would return "LD57", not "LDDP"
 138     // Implementation assumes airport codes are unique.
 139     // Returns NULL if unsucessfull.
 140     const FGAirport* findFirstById( const string& id, bool exact = false );
 141
 142     // search for the airport closest to the specified position
 143     // (currently a linear inefficient search so it's probably not
 144     // best to use this at runtime.)  If with_metar is true, then only
 145     // return station id's marked as having metar data.
 146     // Returns NULL if fails (unlikely unless none have metar and with_metar spec'd!)
 147     FGAirport* search( double lon_deg, double lat_deg, bool with_metar );
 148
 149     /**
 150      * Return the number of airports in the list.
 151      */
 152     int size() const;
 153
 154     /**
 155      * Return a specific airport, by position.
 156      */
 157     const FGAirport *getAirport( unsigned int index ) const;
 158
 159     /**
 160      * Return a pointer to the raw airport list
 161      */
 162     inline const airport_list* getAirportList() { return (&airports_array); }
 163
 164     /**
 165      * Mark the specified airport record as not having metar
 166      */
 167     void no_metar( const string &id );
 168
 169     /**
 170      * Mark the specified airport record as (yes) having metar
 171      */
 172     void has_metar( const string &id );
 173
 174 };
 175
 176 // find basic airport location info from airport database
 177 const FGAirport *fgFindAirportID( const string& id);
 178
 179 // get airport elevation
 180 double fgGetAirportElev( const string& id );
 181
 182 // get airport position
 183 Point3D fgGetAirportPos( const string& id );
 184
 185 #endif // _FG_SIMPLE_HXX
 186
 187