src/Airports/simple.cxx

   1 //
   2 // simple.cxx -- a really simplistic class to manage airport ID,
   3 //               lat, lon of the center of one of it's runways, and
   4 //               elevation in feet.
   5 //
   6 // Written by Curtis Olson, started April 1998.
   7 // Updated by Durk Talsma, started December, 2004.
   8 //
   9 // Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
  10 //
  11 // This program is free software; you can redistribute it and/or
  12 // modify it under the terms of the GNU General Public License as
  13 // published by the Free Software Foundation; either version 2 of the
  14 // License, or (at your option) any later version.
  15 //
  16 // This program is distributed in the hope that it will be useful, but
  17 // WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 // General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU General Public License
  22 // along with this program; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  24 //
  25 // $Id$
  26
  27 #ifdef HAVE_CONFIG_H
  28 #  include <config.h>
  29 #endif
  30
  31 #include <math.h>
  32 #include <algorithm>
  33
  34 #include <simgear/compiler.h>
  35
  36 #include <Environment/environment_mgr.hxx>
  37 #include <Environment/environment.hxx>
  38 #include <simgear/misc/sg_path.hxx>
  39 #include <simgear/props/props.hxx>
  40 #include <simgear/structure/subsystem_mgr.hxx>
  41 #include <simgear/debug/logstream.hxx>
  42 #include <Main/globals.hxx>
  43 #include <Main/fg_props.hxx>
  44 #include <Airports/runways.hxx>
  45 #include <Airports/dynamics.hxx>
  46
  47 #include <string>
  48
  49 #include "simple.hxx"
  50 #include "xmlloader.hxx"
  51
  52 using std::sort;
  53 using std::random_shuffle;
  54
  55
  56
  57
  58 /***************************************************************************
  59  * FGAirport
  60  ***************************************************************************/
  61
  62 FGAirport::FGAirport(const string &id, const SGGeod& location, const SGGeod& tower_location,
  63         const string &name, bool has_metar, Type aType) :
  64     FGPositioned(aType, id, location),
  65     _tower_location(tower_location),
  66     _name(name),
  67     _has_metar(has_metar),
  68     _dynamics(0)
  69 {
  70 }
  71
  72
  73 FGAirport::~FGAirport()
  74 {
  75     delete _dynamics;
  76 }
  77
  78 bool FGAirport::isAirport() const
  79 {
  80   return type() == AIRPORT;
  81 }
  82
  83 bool FGAirport::isSeaport() const
  84 {
  85   return type() == SEAPORT;
  86 }
  87
  88 bool FGAirport::isHeliport() const
  89 {
  90   return type() == HELIPORT;
  91 }
  92
  93 FGAirportDynamics * FGAirport::getDynamics()
  94 {
  95     if (_dynamics != 0) {
  96         return _dynamics;
  97     } else {
  98         //cerr << "Trying to load dynamics for " << _id << endl;
  99         _dynamics = new FGAirportDynamics(this);
 100         XMLLoader::load(_dynamics);
 101
 102         FGRunwayPreference rwyPrefs(this);
 103         XMLLoader::load(&rwyPrefs);
 104         _dynamics->setRwyUse(rwyPrefs);
 105    }
 106     return _dynamics;
 107 }
 108
 109 unsigned int FGAirport::numRunways() const
 110 {
 111   return mRunways.size();
 112 }
 113
 114 FGRunway* FGAirport::getRunwayByIndex(unsigned int aIndex) const
 115 {
 116   assert(aIndex >= 0 && aIndex < mRunways.size());
 117   return mRunways[aIndex];
 118 }
 119
 120 bool FGAirport::hasRunwayWithIdent(const string& aIdent) const
 121 {
 122   return (getIteratorForRunwayIdent(aIdent) != mRunways.end());
 123 }
 124
 125 FGRunway* FGAirport::getRunwayByIdent(const string& aIdent) const
 126 {
 127   Runway_iterator it = getIteratorForRunwayIdent(aIdent);
 128   if (it == mRunways.end()) {
 129     SG_LOG(SG_GENERAL, SG_ALERT, "no such runway '" << aIdent << "' at airport " << ident());
 130     throw sg_range_exception("unknown runway " + aIdent + " at airport:" + ident(), "FGAirport::getRunwayByIdent");
 131   }
 132
 133   return *it;
 134 }
 135
 136 FGAirport::Runway_iterator
 137 FGAirport::getIteratorForRunwayIdent(const string& aIdent) const
 138 {
 139   string ident(aIdent);
 140   if ((aIdent.size() == 1) || !isdigit(aIdent[1])) {
 141     ident = "0" + aIdent;
 142   }
 143
 144   Runway_iterator it = mRunways.begin();
 145   for (; it != mRunways.end(); ++it) {
 146     if ((*it)->ident() == ident) {
 147       return it;
 148     }
 149   }
 150
 151   return it; // end()
 152 }
 153
 154 static double normaliseBearing(double aBearing)
 155 {
 156   while (aBearing < -180) {
 157     aBearing += 360.0;
 158   }
 159
 160   while (aBearing > 180.0) {
 161     aBearing -= 360.0;
 162   }
 163
 164   return aBearing;
 165 }
 166
 167 FGRunway* FGAirport::findBestRunwayForHeading(double aHeading) const
 168 {
 169   Runway_iterator it = mRunways.begin();
 170   FGRunway* result = NULL;
 171   double currentBestQuality = 0.0;
 172
 173   SGPropertyNode *param = fgGetNode("/sim/airport/runways/search", true);
 174   double lengthWeight = param->getDoubleValue("length-weight", 0.01);
 175   double widthWeight = param->getDoubleValue("width-weight", 0.01);
 176   double surfaceWeight = param->getDoubleValue("surface-weight", 10);
 177   double deviationWeight = param->getDoubleValue("deviation-weight", 1);
 178
 179   for (; it != mRunways.end(); ++it) {
 180     double good = (*it)->score(lengthWeight, widthWeight, surfaceWeight);
 181
 182     double dev = normaliseBearing(aHeading - (*it)->headingDeg());
 183     double bad = fabs(deviationWeight * dev) + 1e-20;
 184     double quality = good / bad;
 185
 186     if (quality > currentBestQuality) {
 187       currentBestQuality = quality;
 188       result = *it;
 189     }
 190   }
 191
 192   return result;
 193 }
 194
 195 unsigned int FGAirport::numTaxiways() const
 196 {
 197   return mTaxiways.size();
 198 }
 199
 200 FGRunway* FGAirport::getTaxiwayByIndex(unsigned int aIndex) const
 201 {
 202   assert(aIndex >= 0 && aIndex < mTaxiways.size());
 203   return mTaxiways[aIndex];
 204 }
 205
 206 void FGAirport::addRunway(FGRunway* aRunway)
 207 {
 208   aRunway->setAirport(this);
 209
 210   if (aRunway->isTaxiway()) {
 211     mTaxiways.push_back(aRunway);
 212   } else {
 213     mRunways.push_back(aRunway);
 214   }
 215 }
 216
 217 FGRunway* FGAirport::getActiveRunwayForUsage() const
 218 {
 219   static FGEnvironmentMgr* envMgr = NULL;
 220   if (!envMgr) {
 221     envMgr = (FGEnvironmentMgr *) globals->get_subsystem("environment");
 222   }
 223
 224   FGEnvironment stationWeather(envMgr->getEnvironment(mPosition));
 225
 226   double windSpeed = stationWeather.get_wind_speed_kt();
 227   double hdg = stationWeather.get_wind_from_heading_deg();
 228   if (windSpeed <= 0.0) {
 229     hdg = 270;  // This forces West-facing rwys to be used in no-wind situations
 230     // which is consistent with Flightgear's initial setup.
 231   }
 232
 233   return findBestRunwayForHeading(hdg);
 234 }
 235
 236 /******************************************************************************
 237  * FGAirportList
 238  *****************************************************************************/
 239
 240 // Populates a list of subdirectories of $FG_ROOT/Airports/AI so that
 241 // the add() method doesn't have to try opening 2 XML files in each of
 242 // thousands of non-existent directories.  FIXME: should probably add
 243 // code to free this list after parsing of apt.dat is finished;
 244 // non-issue at the moment, however, as there are no AI subdirectories
 245 // in the base package.
 246 //
 247 // Note: 2005/12/23: This is probably not necessary anymore, because I'm
 248 // Switching to runtime airport dynamics loading (DT).
 249 FGAirportList::FGAirportList()
 250 {
 251 //     ulDir* d;
 252 //     ulDirEnt* dent;
 253 //     SGPath aid( globals->get_fg_root() );
 254 //     aid.append( "/Airports/AI" );
 255 //     if((d = ulOpenDir(aid.c_str())) == NULL)
 256 //         return;
 257 //     while((dent = ulReadDir(d)) != NULL) {
 258 //         SG_LOG( SG_GENERAL, SG_DEBUG, "Dent: " << dent->d_name );
 259 //         ai_dirs.insert(dent->d_name);
 260 //     }
 261 //     ulCloseDir(d);
 262 }
 263
 264
 265 FGAirportList::~FGAirportList( void )
 266 {
 267     for (unsigned int i = 0; i < airports_array.size(); ++i) {
 268         delete airports_array[i];
 269     }
 270 }
 271
 272
 273 // add an entry to the list
 274 FGAirport* FGAirportList::add( const string &id, const SGGeod& location, const SGGeod& tower_location,
 275                          const string &name, bool has_metar, FGPositioned::Type aType)
 276 {
 277     FGAirport* a = new FGAirport(id, location, tower_location, name, has_metar, aType);
 278     airports_by_id[a->getId()] = a;
 279     // try and read in an auxilary file
 280
 281     airports_array.push_back( a );
 282     SG_LOG( SG_GENERAL, SG_BULK, "Adding " << id << " pos = " << location.getLongitudeDeg()
 283             << ", " << location.getLatitudeDeg() << " elev = " << location.getElevationFt() );
 284
 285     return a;
 286 }
 287
 288
 289 // search for the specified id
 290 FGAirport* FGAirportList::search( const string& id)
 291 {
 292     airport_map_iterator itr = airports_by_id.find(id);
 293     return (itr == airports_by_id.end() ? NULL : itr->second);
 294 }
 295
 296 // wrap an FGIdentOrdering in an STL-compatible functor. not the most
 297 // efficent / pretty thing in the world, but avoids template nastiness in the
 298 // headers, and we're only doing O(log(N)) comparisoms per search
 299 class orderingFunctor
 300 {
 301 public:
 302   orderingFunctor(FGIdentOrdering* aOrder) :
 303     mOrdering(aOrder)
 304   { assert(aOrder); }
 305
 306   bool operator()(const airport_map::value_type& aA, const std::string& aB) const
 307   {
 308     return mOrdering->compare(aA.first,aB);
 309   }
 310
 311   bool operator()(const std::string& aA, const airport_map::value_type& aB) const
 312   {
 313     return mOrdering->compare(aA, aB.first);
 314   }
 315
 316   bool operator()(const airport_map::value_type& aA, const airport_map::value_type& aB) const
 317   {
 318     return mOrdering->compare(aA.first, aB.first);
 319   }
 320
 321 private:
 322   FGIdentOrdering* mOrdering;
 323 };
 324
 325 const FGAirport* FGAirportList::findFirstById(const std::string& aIdent, FGIdentOrdering* aOrder)
 326 {
 327   airport_map_iterator itr;
 328   if (aOrder) {
 329     orderingFunctor func(aOrder);
 330     itr = std::lower_bound(airports_by_id.begin(),airports_by_id.end(), aIdent, func);
 331   } else {
 332     itr = airports_by_id.lower_bound(aIdent);
 333   }
 334
 335   if (itr == airports_by_id.end()) {
 336     return NULL;
 337   }
 338
 339   return itr->second;
 340 }
 341
 342 // search for the airport nearest the specified position
 343 FGAirport* FGAirportList::search(double lon_deg, double lat_deg, double max_range)
 344 {
 345     static FGAirportSearchFilter accept_any;
 346     return search(lon_deg, lat_deg, max_range, accept_any);
 347 }
 348
 349
 350 // search for the airport nearest the specified position and
 351 // passing the filter
 352 FGAirport* FGAirportList::search(double lon_deg, double lat_deg,
 353         double max_range,
 354         FGAirportSearchFilter& filter)
 355 {
 356     double min_dist = max_range;
 357
 358     airport_list_iterator it = airports_array.begin();
 359     airport_list_iterator end = airports_array.end();
 360     airport_list_iterator closest = end;
 361     for (; it != end; ++it) {
 362         if (!filter.pass(*it))
 363             continue;
 364
 365         // crude manhatten distance based on lat/lon difference
 366         double d = fabs(lon_deg - (*it)->getLongitude())
 367                 + fabs(lat_deg - (*it)->getLatitude());
 368         if (d < min_dist) {
 369             closest = it;
 370             min_dist = d;
 371         }
 372     }
 373     return closest != end ? *closest : 0;
 374 }
 375
 376
 377 int
 378 FGAirportList::size () const
 379 {
 380     return airports_array.size();
 381 }
 382
 383
 384 const FGAirport *FGAirportList::getAirport( unsigned int index ) const
 385 {
 386     if (index < airports_array.size()) {
 387         return(airports_array[index]);
 388     } else {
 389         return(NULL);
 390     }
 391 }
 392
 393
 394 /**
 395  * Mark the specified airport record as not having metar
 396  */
 397 void FGAirportList::no_metar( const string &id )
 398 {
 399     if(airports_by_id.find(id) != airports_by_id.end()) {
 400         airports_by_id[id]->setMetar(false);
 401     }
 402 }
 403
 404
 405 /**
 406  * Mark the specified airport record as (yes) having metar
 407  */
 408 void FGAirportList::has_metar( const string &id )
 409 {
 410     if(airports_by_id.find(id) != airports_by_id.end()) {
 411         airports_by_id[id]->setMetar(true);
 412     }
 413 }
 414
 415
 416 // find basic airport location info from airport database
 417 const FGAirport *fgFindAirportID( const string& id)
 418 {
 419     const FGAirport* result = NULL;
 420     if ( id.length() ) {
 421         SG_LOG( SG_GENERAL, SG_BULK, "Searching for airport code = " << id );
 422
 423         result = globals->get_airports()->search( id );
 424
 425         if ( result == NULL ) {
 426             SG_LOG( SG_GENERAL, SG_ALERT,
 427                     "Failed to find " << id << " in apt.dat.gz" );
 428             return NULL;
 429         }
 430     } else {
 431         return NULL;
 432     }
 433     SG_LOG( SG_GENERAL, SG_BULK,
 434             "Position for " << id << " is ("
 435             << result->getLongitude() << ", "
 436             << result->getLatitude() << ")" );
 437
 438     return result;
 439 }
 440
 441
 442 // get airport elevation
 443 double fgGetAirportElev( const string& id )
 444 {
 445     SG_LOG( SG_GENERAL, SG_BULK,
 446             "Finding elevation for airport: " << id );
 447
 448     const FGAirport *a=fgFindAirportID( id);
 449     if (a) {
 450         return a->getElevation();
 451     } else {
 452         return -9999.0;
 453     }
 454 }
 455
 456
 457 // get airport position
 458 Point3D fgGetAirportPos( const string& id )
 459 {
 460     SG_LOG( SG_ATC, SG_BULK,
 461             "Finding position for airport: " << id );
 462
 463     const FGAirport *a = fgFindAirportID( id);
 464
 465     if (a) {
 466         return Point3D(a->getLongitude(), a->getLatitude(), a->getElevation());
 467     } else {
 468         return Point3D(0.0, 0.0, -9999.0);
 469     }
 470 }