]> git.mxchange.org Git - flightgear.git/blobdiff - src/Airports/simple.cxx
Clean out FGAirportList - not quite obsolete yet, but the spatial queries are
[flightgear.git] / src / Airports / simple.cxx
index cfbb61ac24092b841883d75331581a575aa9d343..e7b9a48d88344448732bfdc53c8e55b932ab1f0d 100644 (file)
@@ -1,11 +1,12 @@
 //
 // simple.cxx -- a really simplistic class to manage airport ID,
-//               lat, lon of the center of one of it's runways, and 
+//               lat, lon of the center of one of it's runways, and
 //               elevation in feet.
 //
 // Written by Curtis Olson, started April 1998.
+// Updated by Durk Talsma, started December, 2004.
 //
-// Copyright (C) 1998  Curtis L. Olson  - curt@me.umn.edu
+// Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
@@ -19,7 +20,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 #endif
 
 #include <math.h>
+#include <algorithm>
 
 #include <simgear/compiler.h>
 
+#include <Environment/environment_mgr.hxx>
+#include <Environment/environment.hxx>
+#include <simgear/misc/sg_path.hxx>
+#include <simgear/props/props.hxx>
+#include <simgear/structure/subsystem_mgr.hxx>
 #include <simgear/debug/logstream.hxx>
-#include <simgear/misc/sgstream.hxx>
+#include <Main/globals.hxx>
+#include <Main/fg_props.hxx>
+#include <Airports/runways.hxx>
+#include <Airports/dynamics.hxx>
 
-#include STL_STRING
-#include STL_IOSTREAM
+#include <string>
 
 #include "simple.hxx"
+#include "xmlloader.hxx"
 
-SG_USING_NAMESPACE(std);
-SG_USING_STD(istream);
+using std::sort;
+using std::random_shuffle;
 
 
-inline istream&
-operator >> ( istream& in, FGAirport& a )
+
+
+/***************************************************************************
+ * FGAirport
+ ***************************************************************************/
+
+FGAirport::FGAirport(const string &id, const SGGeod& location, const SGGeod& tower_location,
+        const string &name, bool has_metar, Type aType) :
+    FGPositioned(aType, id, location),
+    _tower_location(tower_location),
+    _name(name),
+    _has_metar(has_metar),
+    _dynamics(0)
 {
-    string junk;
-    in >> junk >> a.id >> a.latitude >> a.longitude >> a.elevation
-       >> a.code;
+}
 
-    getline( in,a.name );
 
-    // Remove the space before the name
-    if ( a.name.substr(0,1) == " " ) {
-        a.name = a.name.erase(0,1);
-    }
+FGAirport::~FGAirport()
+{
+    delete _dynamics;
+}
 
-    a.has_metar = false;
+bool FGAirport::isAirport() const
+{
+  return type() == AIRPORT;
+}
 
-#if 0
-    // As a quick seed for the has_metar value, only airports with
-    // four-letter codes can have metar stations
-    a.has_metar = (isalpha(a.id[0]) && isalpha(a.id[1]) && isalpha(a.id[2])
-        && isalpha(a.id[3]) && !a.id[4]);
-#endif
+bool FGAirport::isSeaport() const
+{
+  return type() == SEAPORT;
+}
 
-    return in;
+bool FGAirport::isHeliport() const
+{
+  return type() == HELIPORT;
 }
 
+FGAirportDynamics * FGAirport::getDynamics()
+{
+    if (_dynamics != 0) {
+        return _dynamics;
+    } else {
+        //cerr << "Trying to load dynamics for " << _id << endl;
+        _dynamics = new FGAirportDynamics(this);
+        XMLLoader::load(_dynamics);
+
+        FGRunwayPreference rwyPrefs(this);
+        XMLLoader::load(&rwyPrefs);
+        _dynamics->setRwyUse(rwyPrefs);
+   }
+    return _dynamics;
+}
 
-FGAirportList::FGAirportList( const string &airport_file,
-                              const string &metar_file ) {
-    SG_LOG( SG_GENERAL, SG_INFO, "Reading simple airport list: "
-            << airport_file );
+unsigned int FGAirport::numRunways() const
+{
+  return mRunways.size();
+}
 
-    // open the specified file for reading
-    sg_gzifstream apt_in( airport_file );
-    if ( !apt_in.is_open() ) {
-        SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << airport_file );
-       exit(-1);
-    }
+FGRunway* FGAirport::getRunwayByIndex(unsigned int aIndex) const
+{
+  assert(aIndex >= 0 && aIndex < mRunways.size());
+  return mRunways[aIndex];
+}
+
+bool FGAirport::hasRunwayWithIdent(const string& aIdent) const
+{
+  return (getIteratorForRunwayIdent(aIdent) != mRunways.end());
+}
 
-    // skip header line
-    apt_in >> skipeol;
+FGRunway* FGAirport::getRunwayByIdent(const string& aIdent) const
+{
+  Runway_iterator it = getIteratorForRunwayIdent(aIdent);
+  if (it == mRunways.end()) {
+    SG_LOG(SG_GENERAL, SG_ALERT, "no such runway '" << aIdent << "' at airport " << ident());
+    throw sg_range_exception("unknown runway " + aIdent + " at airport:" + ident(), "FGAirport::getRunwayByIdent");
+  }
+  
+  return *it;
+}
 
-    FGAirport a;
-    while ( apt_in ) {
-        apt_in >> a;
-        airports_by_id[a.id] = a;
-        airports_array.push_back( &airports_by_id[a.id] );
+FGAirport::Runway_iterator
+FGAirport::getIteratorForRunwayIdent(const string& aIdent) const
+{
+  string ident(aIdent);
+  if ((aIdent.size() == 1) || !isdigit(aIdent[1])) {
+    ident = "0" + aIdent;
+  }
+
+  Runway_iterator it = mRunways.begin();
+  for (; it != mRunways.end(); ++it) {
+    if ((*it)->ident() == ident) {
+      return it;
     }
+  }
 
+  return it; // end()
+}
 
-    SG_LOG( SG_GENERAL, SG_INFO, "Reading simple metar station list: "
-            << metar_file );
+static double normaliseBearing(double aBearing)
+{
+  while (aBearing < -180) {
+    aBearing += 360.0;
+  }
+  
+  while (aBearing > 180.0) {
+    aBearing -= 360.0;
+  }
+  
+  return aBearing;
+}
 
-    // open the specified file for reading
-    sg_gzifstream metar_in( metar_file );
-    if ( !metar_in.is_open() ) {
-        SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << metar_file );
+FGRunway* FGAirport::findBestRunwayForHeading(double aHeading) const
+{
+  Runway_iterator it = mRunways.begin();
+  FGRunway* result = NULL;
+  double currentBestQuality = 0.0;
+  
+  SGPropertyNode *param = fgGetNode("/sim/airport/runways/search", true);
+  double lengthWeight = param->getDoubleValue("length-weight", 0.01);
+  double widthWeight = param->getDoubleValue("width-weight", 0.01);
+  double surfaceWeight = param->getDoubleValue("surface-weight", 10);
+  double deviationWeight = param->getDoubleValue("deviation-weight", 1);
+    
+  for (; it != mRunways.end(); ++it) {
+    double good = (*it)->score(lengthWeight, widthWeight, surfaceWeight);
+    
+    double dev = normaliseBearing(aHeading - (*it)->headingDeg());
+    double bad = fabs(deviationWeight * dev) + 1e-20;
+    double quality = good / bad;
+    
+    if (quality > currentBestQuality) {
+      currentBestQuality = quality;
+      result = *it;
     }
+  }
 
-    string ident;
-    while ( metar_in ) {
-        metar_in >> ident;
-        if ( ident == "#" || ident == "//" ) {
-            metar_in >> skipeol;
-        } else {
-            airport_map_iterator apt = airports_by_id.find( ident );
-            if ( apt == airports_by_id.end() ) {
-                SG_LOG( SG_GENERAL, SG_DEBUG, "no apt = " << ident );
-            } else {
-                SG_LOG( SG_GENERAL, SG_DEBUG, "metar = " << ident );
-                airports_by_id[ident].has_metar = true;
-            }
-        }
-    }
+  return result;
 }
 
+bool FGAirport::hasHardRunwayOfLengthFt(double aLengthFt) const
+{
+  unsigned int numRunways(mRunways.size());
+  for (unsigned int r=0; r<numRunways; ++r) {
+    FGRunway* rwy = mRunways[r];
+    if (rwy->isReciprocal()) {
+      continue; // we only care about lengths, so don't do work twice
+    }
 
-// search for the specified id
-FGAirport FGAirportList::search( const string& id) {
-    return airports_by_id[id];
-}
-
-
-// search for the airport nearest the specified position
-FGAirport FGAirportList::search( double lon_deg, double lat_deg,
-                                 bool with_metar ) {
-    int closest = 0;
-    double min_dist = 360.0;
-    unsigned int i;
-    for ( i = 0; i < airports_array.size(); ++i ) {
-        // crude manhatten distance based on lat/lon difference
-        double d = fabs(lon_deg - airports_array[i]->longitude)
-            + fabs(lat_deg - airports_array[i]->latitude);
-        if ( d < min_dist ) {
-            if ( !with_metar || (with_metar && airports_array[i]->has_metar) ) {
-                closest = i;
-                min_dist = d;
-            }
-        }
+    if (rwy->isHardSurface() && (rwy->lengthFt() >= aLengthFt)) {
+      return true; // we're done!
     }
+  } // of runways iteration
 
-    return *airports_array[closest];
+  return false;
 }
 
+unsigned int FGAirport::numTaxiways() const
+{
+  return mTaxiways.size();
+}
 
-// Destructor
-FGAirportList::~FGAirportList( void ) {
+FGRunway* FGAirport::getTaxiwayByIndex(unsigned int aIndex) const
+{
+  assert(aIndex >= 0 && aIndex < mTaxiways.size());
+  return mTaxiways[aIndex];
+}
+
+void FGAirport::addRunway(FGRunway* aRunway)
+{
+  aRunway->setAirport(this);
+  
+  if (aRunway->isTaxiway()) {
+    mTaxiways.push_back(aRunway);
+  } else {
+    mRunways.push_back(aRunway);
+  }
+}
+
+FGRunway* FGAirport::getActiveRunwayForUsage() const
+{
+  static FGEnvironmentMgr* envMgr = NULL;
+  if (!envMgr) {
+    envMgr = (FGEnvironmentMgr *) globals->get_subsystem("environment");
+  }
+  
+  FGEnvironment stationWeather(envMgr->getEnvironment(mPosition));
+  
+  double windSpeed = stationWeather.get_wind_speed_kt();
+  double hdg = stationWeather.get_wind_from_heading_deg();
+  if (windSpeed <= 0.0) {
+    hdg = 270; // This forces West-facing rwys to be used in no-wind situations
+    // which is consistent with Flightgear's initial setup.
+  }
+  
+  return findBestRunwayForHeading(hdg);
+}
+
+FGAirport* FGAirport::findClosest(const SGGeod& aPos, double aCuttofNm, Filter* filter)
+{
+  AirportFilter aptFilter;
+  if (filter == NULL) {
+    filter = &aptFilter;
+  }
+  
+  FGPositionedRef r = FGPositioned::findClosest(aPos, aCuttofNm, filter);
+  if (!r) {
+    return NULL;
+  }
+  
+  return static_cast<FGAirport*>(r.ptr());
+}
+
+FGAirport::HardSurfaceFilter::HardSurfaceFilter(double minLengthFt) :
+  mMinLengthFt(minLengthFt)
+{
+}
+      
+bool FGAirport::HardSurfaceFilter::pass(FGPositioned* aPos) const
+{
+  if (aPos->type() != AIRPORT) {
+    return false; // exclude seaports and heliports as well, we need a runways
+  }
+   
+  return static_cast<FGAirport*>(aPos)->hasHardRunwayOfLengthFt(mMinLengthFt);
+}
+
+/******************************************************************************
+ * FGAirportList
+ *****************************************************************************/
+
+// Populates a list of subdirectories of $FG_ROOT/Airports/AI so that
+// the add() method doesn't have to try opening 2 XML files in each of
+// thousands of non-existent directories.  FIXME: should probably add
+// code to free this list after parsing of apt.dat is finished;
+// non-issue at the moment, however, as there are no AI subdirectories
+// in the base package.
+//
+// Note: 2005/12/23: This is probably not necessary anymore, because I'm
+// Switching to runtime airport dynamics loading (DT).
+FGAirportList::FGAirportList()
+{
+//     ulDir* d;
+//     ulDirEnt* dent;
+//     SGPath aid( globals->get_fg_root() );
+//     aid.append( "/Airports/AI" );
+//     if((d = ulOpenDir(aid.c_str())) == NULL)
+//         return;
+//     while((dent = ulReadDir(d)) != NULL) {
+//         SG_LOG( SG_GENERAL, SG_DEBUG, "Dent: " << dent->d_name );
+//         ai_dirs.insert(dent->d_name);
+//     }
+//     ulCloseDir(d);
+}
+
+
+FGAirportList::~FGAirportList( void )
+{
+    for (unsigned int i = 0; i < airports_array.size(); ++i) {
+        delete airports_array[i];
+    }
+}
+
+
+// add an entry to the list
+FGAirport* FGAirportList::add( const string &id, const SGGeod& location, const SGGeod& tower_location,
+                         const string &name, bool has_metar, FGPositioned::Type aType)
+{
+    FGAirport* a = new FGAirport(id, location, tower_location, name, has_metar, aType);
+    airports_by_id[a->getId()] = a;
+    // try and read in an auxilary file
+
+    airports_array.push_back( a );
+    return a;
+}
+
+// search for the specified id
+FGAirport* FGAirportList::search( const string& id)
+{
+    airport_map_iterator itr = airports_by_id.find(id);
+    return (itr == airports_by_id.end() ? NULL : itr->second);
 }
 
 int
@@ -158,15 +341,68 @@ FGAirportList::size () const
     return airports_array.size();
 }
 
-const FGAirport *FGAirportList::getAirport( int index ) const
+
+const FGAirport *FGAirportList::getAirport( unsigned int index ) const
+{
+    if (index < airports_array.size()) {
+        return(airports_array[index]);
+    } else {
+        return(NULL);
+    }
+}
+
+// find basic airport location info from airport database
+const FGAirport *fgFindAirportID( const string& id)
+{
+    const FGAirport* result = NULL;
+    if ( id.length() ) {
+        SG_LOG( SG_GENERAL, SG_BULK, "Searching for airport code = " << id );
+
+        result = globals->get_airports()->search( id );
+
+        if ( result == NULL ) {
+            SG_LOG( SG_GENERAL, SG_ALERT,
+                    "Failed to find " << id << " in apt.dat.gz" );
+            return NULL;
+        }
+    } else {
+        return NULL;
+    }
+    SG_LOG( SG_GENERAL, SG_BULK,
+            "Position for " << id << " is ("
+            << result->getLongitude() << ", "
+            << result->getLatitude() << ")" );
+
+    return result;
+}
+
+
+// get airport elevation
+double fgGetAirportElev( const string& id )
 {
-    return airports_array[index];
+    SG_LOG( SG_GENERAL, SG_BULK,
+            "Finding elevation for airport: " << id );
+
+    const FGAirport *a=fgFindAirportID( id);
+    if (a) {
+        return a->getElevation();
+    } else {
+        return -9999.0;
+    }
 }
 
 
-/**
- * Mark the specified airport record as not having metar
- */
-void FGAirportList::no_metar( const string &id ) {
-    airports_by_id[id].has_metar = false;
+// get airport position
+Point3D fgGetAirportPos( const string& id )
+{
+    SG_LOG( SG_ATC, SG_BULK,
+            "Finding position for airport: " << id );
+
+    const FGAirport *a = fgFindAirportID( id);
+
+    if (a) {
+        return Point3D(a->getLongitude(), a->getLatitude(), a->getElevation());
+    } else {
+        return Point3D(0.0, 0.0, -9999.0);
+    }
 }