]> git.mxchange.org Git - flightgear.git/blobdiff - src/Airports/simple.cxx
Update FGRunway to process information from threshold.xml files.
[flightgear.git] / src / Airports / simple.cxx
index 0b9c39097e57e8203f6b592180abc4ff413ede9e..bf6620f945fd9cf42d1abc2b8f170e8ea6d171ca 100644 (file)
 #  include <config.h>
 #endif
 
-#include <math.h>
-#include <algorithm>
-
-#include <simgear/compiler.h>
-
-#include <plib/sg.h>
-#include <plib/ul.h>
+#include "simple.hxx"
 
-#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/route/waypoint.hxx>
+#include <simgear/props/props_io.hxx>
 #include <simgear/debug/logstream.hxx>
-#include <Main/globals.hxx>
+#include <simgear/sg_inlines.h>
+
+#include <Environment/environment_mgr.hxx>
+#include <Environment/environment.hxx>
 #include <Main/fg_props.hxx>
 #include <Airports/runways.hxx>
+#include <Airports/pavement.hxx>
+#include <Airports/dynamics.hxx>
+#include <Airports/xmlloader.hxx>
 
-#include STL_STRING
-
-#include "simple.hxx"
-#include "xmlloader.hxx"
-
-SG_USING_STD(sort);
-SG_USING_STD(random_shuffle);
-
-
-
+// magic import of a helper which uses FGPositioned internals
+extern char** searchAirportNamesAndIdents(const std::string& aFilter);
 
 /***************************************************************************
  * FGAirport
  ***************************************************************************/
-FGAirport::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),
+    mRunwaysLoaded(false),
+    mTaxiwaysLoaded(true)
 {
-    dynamics = 0;
 }
 
-FGAirport::FGAirport(const string &id, const SGGeod& location, const SGGeod& tower_location, const string &name, bool has_metar)
+
+FGAirport::~FGAirport()
 {
-    _id = id;
-    _location = location;
-    _tower_location = tower_location;
-    _name      = name;
-    _has_metar = has_metar;
-    dynamics   = 0;
+    delete _dynamics;
 }
 
+bool FGAirport::isAirport() const
+{
+  return type() == AIRPORT;
+}
 
-FGAirport::~FGAirport()
+bool FGAirport::isSeaport() const
 {
-    delete dynamics;
+  return type() == SEAPORT;
 }
 
+bool FGAirport::isHeliport() const
+{
+  return type() == HELIPORT;
+}
 
 FGAirportDynamics * FGAirport::getDynamics()
 {
-    if (dynamics != 0) {
-        return dynamics;
+    if (_dynamics != 0) {
+        return _dynamics;
     } else {
         //cerr << "Trying to load dynamics for " << _id << endl;
-        dynamics = new FGAirportDynamics(this);
-        XMLLoader::load(dynamics);
+        _dynamics = new FGAirportDynamics(this);
+        XMLLoader::load(_dynamics);
 
         FGRunwayPreference rwyPrefs(this);
         XMLLoader::load(&rwyPrefs);
-        dynamics->setRwyUse(rwyPrefs);
+        _dynamics->setRwyUse(rwyPrefs);
+
+        //FGSidStar SIDs(this);
+        XMLLoader::load(_dynamics->getSIDs());
    }
-    return dynamics;
+    return _dynamics;
 }
 
-
-
-
-
-/******************************************************************************
- * 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()
+unsigned int FGAirport::numRunways() const
 {
-//     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);
+  loadRunways();
+  return mRunways.size();
 }
 
-
-FGAirportList::~FGAirportList( void )
+FGRunway* FGAirport::getRunwayByIndex(unsigned int aIndex) const
 {
-    for (unsigned int i = 0; i < airports_array.size(); ++i) {
-        delete airports_array[i];
-    }
+  loadRunways();
+  
+  assert(aIndex >= 0 && aIndex < mRunways.size());
+  return mRunways[aIndex];
 }
 
-
-// add an entry to the list
-void FGAirportList::add( const string &id, const SGGeod& location, const SGGeod& tower_location,
-                         const string &name, const bool has_metar )
+bool FGAirport::hasRunwayWithIdent(const string& aIdent) const
 {
-    FGAirport* a = new FGAirport(id, location, tower_location, name, has_metar);
-    airports_by_id[a->getId()] = a;
-    // try and read in an auxilary file
-    airports_array.push_back( a );
-    SG_LOG( SG_GENERAL, SG_BULK, "Adding " << id << " pos = " << location.getLongitudeDeg()
-            << ", " << location.getLatitudeDeg() << " elev = " << location.getElevationFt() );
+  return (getIteratorForRunwayIdent(aIdent) != mRunways.end());
 }
 
-
-// search for the specified id
-FGAirport* FGAirportList::search( const string& id)
+FGRunway* FGAirport::getRunwayByIdent(const string& aIdent) const
 {
-    airport_map_iterator itr = airports_by_id.find(id);
-    return (itr == airports_by_id.end() ? NULL : itr->second);
+  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::Runway_iterator
+FGAirport::getIteratorForRunwayIdent(const string& aIdent) const
+{ 
+  loadRunways();
+  
+  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;
+    }
+  }
 
-// search for first subsequent alphabetically to supplied id
-const FGAirport* FGAirportList::findFirstById( const string& id, bool exact )
+  return it; // end()
+}
+
+FGRunway* FGAirport::findBestRunwayForHeading(double aHeading) const
 {
-    airport_map_iterator itr;
-    if (exact) {
-        itr = airports_by_id.find(id);
-    } else {
-        itr = airports_by_id.lower_bound(id);
-    }
-    if (itr == airports_by_id.end()) {
-        return (NULL);
-    } else {
-        return (itr->second);
+  loadRunways();
+  
+  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 = aHeading - (*it)->headingDeg();
+    SG_NORMALIZE_RANGE(dev, -180.0, 180.0);
+    double bad = fabs(deviationWeight * dev) + 1e-20;
+    double quality = good / bad;
+    
+    if (quality > currentBestQuality) {
+      currentBestQuality = quality;
+      result = *it;
     }
+  }
+
+  return result;
 }
 
+bool FGAirport::hasHardRunwayOfLengthFt(double aLengthFt) const
+{
+  loadRunways();
+  
+  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 airport nearest the specified position
-FGAirport* FGAirportList::search( double lon_deg, double lat_deg,
-                                  bool with_metar )
-{
-    int closest = -1;
-    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]->getLongitude())
-            + fabs(lat_deg - airports_array[i]->getLatitude());
-        if ( d < min_dist ) {
-            if ( !with_metar || (with_metar&&airports_array[i]->getMetar()) ) {
-                closest = i;
-                min_dist = d;
-            }
-        }
+    if (rwy->isHardSurface() && (rwy->lengthFt() >= aLengthFt)) {
+      return true; // we're done!
     }
+  } // of runways iteration
 
-    return ( closest > -1 ? airports_array[closest] : NULL );
+  return false;
 }
 
+unsigned int FGAirport::numTaxiways() const
+{
+  loadTaxiways();
+  return mTaxiways.size();
+}
 
-int
-FGAirportList::size () const
+FGTaxiway* FGAirport::getTaxiwayByIndex(unsigned int aIndex) const
 {
-    return airports_array.size();
+  loadTaxiways();
+  assert(aIndex >= 0 && aIndex < mTaxiways.size());
+  return mTaxiways[aIndex];
 }
 
+unsigned int FGAirport::numPavements() const
+{
+  loadTaxiways();
+  return mPavements.size();
+}
 
-const FGAirport *FGAirportList::getAirport( unsigned int index ) const
+FGPavement* FGAirport::getPavementByIndex(unsigned int aIndex) const
 {
-    if (index < airports_array.size()) {
-        return(airports_array[index]);
-    } else {
-        return(NULL);
-    }
+  loadTaxiways();
+  assert(aIndex >= 0 && aIndex < mPavements.size());
+  return mPavements[aIndex];
 }
 
+void FGAirport::setRunwaysAndTaxiways(vector<FGRunwayPtr>& rwys,
+       vector<FGTaxiwayPtr>& txwys,
+       vector<FGPavementPtr>& pvts)
+{
+  mRunways.swap(rwys);
+  Runway_iterator it = mRunways.begin();
+  for (; it != mRunways.end(); ++it) {
+    (*it)->setAirport(this);
+  }
+
+  mTaxiways.swap(txwys);
+  mPavements.swap(pvts);
+}
 
-/**
- * Mark the specified airport record as not having metar
- */
-void FGAirportList::no_metar( const string &id )
+FGRunway* FGAirport::getActiveRunwayForUsage() const
 {
-    if(airports_by_id.find(id) != airports_by_id.end()) {
-        airports_by_id[id]->setMetar(false);
-    }
+  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());
+}
 
-/**
- * Mark the specified airport record as (yes) having metar
- */
-void FGAirportList::has_metar( const string &id )
+FGAirport::HardSurfaceFilter::HardSurfaceFilter(double minLengthFt) :
+  mMinLengthFt(minLengthFt)
 {
-    if(airports_by_id.find(id) != airports_by_id.end()) {
-        airports_by_id[id]->setMetar(true);
-    }
+}
+      
+bool FGAirport::HardSurfaceFilter::passAirport(FGAirport* aApt) const
+{
+  return aApt->hasHardRunwayOfLengthFt(mMinLengthFt);
 }
 
+FGAirport* FGAirport::findByIdent(const std::string& aIdent)
+{
+  FGPositionedRef r;
+  AirportFilter filter;
+  r = FGPositioned::findNextWithPartialId(r, aIdent, &filter);
+  if (!r) {
+    return NULL; // we don't warn here, let the caller do that
+  }
+  return static_cast<FGAirport*>(r.ptr());
+}
 
-// find basic airport location info from airport database
-const FGAirport *fgFindAirportID( const string& id)
+FGAirport* FGAirport::getByIdent(const std::string& aIdent)
 {
-    const FGAirport* result = NULL;
-    if ( id.length() ) {
-        SG_LOG( SG_GENERAL, SG_BULK, "Searching for airport code = " << id );
+  FGPositionedRef r;
+  AirportFilter filter;
+  r = FGPositioned::findNextWithPartialId(r, aIdent, &filter);
+  if (!r) {
+    throw sg_range_exception("No such airport with ident: " + aIdent);
+  }
+  return static_cast<FGAirport*>(r.ptr());
+}
 
-        result = globals->get_airports()->search( id );
+char** FGAirport::searchNamesAndIdents(const std::string& aFilter)
+{
+  // we delegate all the work to a horrible helper in FGPositioned, which can
+  // access the (private) index data.
+  return searchAirportNamesAndIdents(aFilter);
+}
 
-        if ( result == NULL ) {
-            SG_LOG( SG_GENERAL, SG_ALERT,
-                    "Failed to find " << id << " in apt.dat.gz" );
-            return NULL;
-        }
-    } else {
+// find basic airport location info from airport database
+const FGAirport *fgFindAirportID( const string& id)
+{
+    if ( id.empty() ) {
         return NULL;
     }
-    SG_LOG( SG_GENERAL, SG_BULK,
-            "Position for " << id << " is ("
-            << result->getLongitude() << ", "
-            << result->getLatitude() << ")" );
+    
+    return FGAirport::findByIdent(id);
+}
 
-    return result;
+void FGAirport::loadRunways() const
+{
+  if (mRunwaysLoaded) {
+    return; // already loaded, great
+  }
+  
+  mRunwaysLoaded = true;
+  loadSceneryDefintions();
 }
 
+void FGAirport::loadTaxiways() const
+{
+  if (mTaxiwaysLoaded) {
+    return; // already loaded, great
+  }
+}
+
+void FGAirport::loadSceneryDefintions() const
+{  
+  // allow users to disable the scenery data in the short-term
+  // longer term, this option can probably disappear
+  if (!fgGetBool("/sim/use-scenery-airport-data")) {
+    return; 
+  }
+  
+  SGPath path;
+  SGPropertyNode_ptr rootNode = new SGPropertyNode;
+  if (XMLLoader::findAirportData(ident(), "threshold", path)) {
+    readProperties(path.str(), rootNode);
+    const_cast<FGAirport*>(this)->readThresholdData(rootNode);
+  }
+  
+  // repeat for the tower data
+  rootNode = new SGPropertyNode;
+  if (XMLLoader::findAirportData(ident(), "twr", path)) {
+    readProperties(path.str(), rootNode);
+    const_cast<FGAirport*>(this)->readTowerData(rootNode);
+  }
+}
+
+void FGAirport::readThresholdData(SGPropertyNode* aRoot)
+{
+  SGPropertyNode* runway;
+  int runwayIndex = 0;
+  for (; (runway = aRoot->getChild("runway", runwayIndex)) != NULL; ++runwayIndex) {
+    SGPropertyNode* t0 = runway->getChild("threshold", 0),
+      *t1 = runway->getChild("threshold", 1);
+    assert(t0);
+    assert(t1); // too strict? mayeb we should finally allow single-ended runways
+    
+    processThreshold(t0);
+    processThreshold(t1);
+  } // of runways iteration
+}
+
+void FGAirport::processThreshold(SGPropertyNode* aThreshold)
+{
+  // first, let's identify the current runway
+  string id(aThreshold->getStringValue("rwy"));
+  if (!hasRunwayWithIdent(id)) {
+    SG_LOG(SG_GENERAL, SG_WARN, "FGAirport::processThreshold: "
+      "found runway not defined in the global data:" << ident() << "/" << id);
+    return;
+  }
+  
+  FGRunway* rwy = getRunwayByIdent(id);
+  rwy->processThreshold(aThreshold);
+}
+
+void FGAirport::readTowerData(SGPropertyNode* aRoot)
+{
+  SGPropertyNode* twrNode = aRoot->getChild("tower")->getChild("twr");
+  double lat = twrNode->getDoubleValue("lat"), 
+    lon = twrNode->getDoubleValue("lon"), 
+    elevM = twrNode->getDoubleValue("elev-m");
+    
+  _tower_location = SGGeod::fromDegM(lon, lat, elevM);
+}
 
 // get airport elevation
 double fgGetAirportElev( const string& id )
 {
-    SG_LOG( SG_GENERAL, SG_BULK,
-            "Finding elevation for airport: " << id );
-
     const FGAirport *a=fgFindAirportID( id);
     if (a) {
         return a->getElevation();
@@ -284,16 +418,13 @@ double fgGetAirportElev( const string& id )
 
 
 // get airport position
-Point3D fgGetAirportPos( const string& id )
+SGGeod 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());
+        return SGGeod::fromDegM(a->getLongitude(), a->getLatitude(), a->getElevation());
     } else {
-        return Point3D(0.0, 0.0, -9999.0);
+        return SGGeod::fromDegM(0.0, 0.0, -9999.0);
     }
 }