]> git.mxchange.org Git - flightgear.git/blobdiff - src/Airports/simple.cxx
Bugfix - don't exclude seaports or heliports when looking up by ICAO.
[flightgear.git] / src / Airports / simple.cxx
index 7db6a278787310ac6f64f2fbe26c2f1315c78428..1b7d1c9d0b5fb517aaa8cf02642a1f4ea1ef48c8 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 
-//                 elevation in feet.
+//               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
 //
 // 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$
 
-
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif
 
-// #include <sys/types.h>              // for gdbm open flags
-// #include <sys/stat.h>               // for gdbm open flags
-
-// #ifdef HAVE_GDBM
-// #  include <gdbm.h>
-// #else
-// #  include <simgear/gdbm/gdbm.h>
-// #endif
-
-#include <simgear/compiler.h>
-
-#include <simgear/debug/logstream.hxx>
-#include <simgear/misc/fgstream.hxx>
-
-#include STL_STRING
-#include STL_FUNCTIONAL
-#include STL_ALGORITHM
-
 #include "simple.hxx"
 
-SG_USING_NAMESPACE(std);
-
-FGAirports::FGAirports( const string& file ) {
-    // open the specified database readonly
-    storage = new c4_Storage( file.c_str(), false );
-
-    if ( !storage->Strategy().IsValid() ) {
-       SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << file );
-       exit(-1);
-    }
-
-    vAirport = new c4_View;
-    *vAirport = 
-       storage->GetAs("airport[ID:S,Longitude:F,Latitude:F,Elevation:F]");
+#include <simgear/misc/sg_path.hxx>
+#include <simgear/props/props.hxx>
+#include <simgear/props/props_io.hxx>
+#include <simgear/debug/logstream.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>
+
+// magic import of a helper which uses FGPositioned internals
+extern char** searchAirportNamesAndIdents(const std::string& aFilter);
+
+/***************************************************************************
+ * 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)
+{
 }
 
 
-// search for the specified id
-bool
-FGAirports::search( const string& id, FGAirport* a ) const
+FGAirport::~FGAirport()
 {
-    c4_StringProp pID ("ID");
-    c4_FloatProp pLon ("Longitude");
-    c4_FloatProp pLat ("Latitude");
-    c4_FloatProp pElev ("Elevation");
-
-    int idx = vAirport->Find(pID[id.c_str()]);
-    cout << "idx = " << idx << endl;
-
-    if ( idx == -1 ) {
-       return false;
-    }
-
-    c4_RowRef r = vAirport->GetAt(idx);
-
-    a->longitude = (double) pLon(r);
-    a->latitude =  (double) pLat(r);
-    a->elevation = (double) pElev(r);
-
-    return true;
+    delete _dynamics;
 }
 
-
-FGAirport
-FGAirports::search( const string& id ) const
+bool FGAirport::isAirport() const
 {
-    FGAirport a;
-    search( id, &a );
-    return a;
+  return type() == AIRPORT;
 }
 
+bool FGAirport::isSeaport() const
+{
+  return type() == SEAPORT;
+}
 
-// Destructor
-FGAirports::~FGAirports( void ) {
-    delete storage;
+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);
+
+        //FGSidStar SIDs(this);
+        XMLLoader::load(_dynamics->getSIDs());
+   }
+    return _dynamics;
+}
 
-// Constructor
-FGAirportsUtil::FGAirportsUtil() {
+unsigned int FGAirport::numRunways() const
+{
+  loadRunways();
+  return mRunways.size();
 }
 
+FGRunway* FGAirport::getRunwayByIndex(unsigned int aIndex) const
+{
+  loadRunways();
+  
+  assert(aIndex >= 0 && aIndex < mRunways.size());
+  return mRunways[aIndex];
+}
 
-// load the data
-int FGAirportsUtil::load( const string& file ) {
-    FGAirport a;
+bool FGAirport::hasRunwayWithIdent(const string& aIdent) const
+{
+  return (getIteratorForRunwayIdent(aIdent) != mRunways.end());
+}
 
-    airports.erase( airports.begin(), airports.end() );
+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;
+}
 
-    fg_gzifstream in( file );
-    if ( !in.is_open() ) {
-       SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << file );
-       exit(-1);
+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;
     }
+  }
 
-    // skip first line of file
-    char tmp[256];
-    in.getline( tmp, 256 );
-
+  return it; // end()
+}
 
-    // read in each line of the file
+FGRunway* FGAirport::findBestRunwayForHeading(double aHeading) const
+{
+  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;
+    }
+  }
 
-#ifdef __MWERKS__
+  return result;
+}
 
-    in >> ::skipws;
-    char c = 0;
-    while ( in.get(c) && c != '\0' ) {
-       if ( c == 'A' ) {
-           in >> a;
-           in >> skipeol;
-           airports.insert(a);
-       } else if ( c == 'R' ) {
-           in >> skipeol;
-       } else {
-           in >> skipeol;
-       }
-       in >> ::skipws;
+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
     }
 
-#else
-
-    in >> ::skipws;
-    while ( ! in.eof() ) {
-       char c = 0;
-       in.get(c);
-       if ( c == 'A' ) {
-           in >> a;
-           cout << "in <- " << a.id << endl;
-           in >> skipeol;
-           airports.insert(a);
-       } else if ( c == 'R' ) {
-           in >> skipeol;
-       } else {
-           in >> skipeol;
-       }
-       in >> ::skipws;
+    if (rwy->isHardSurface() && (rwy->lengthFt() >= aLengthFt)) {
+      return true; // we're done!
     }
+  } // of runways iteration
 
-#endif
+  return false;
+}
+
+unsigned int FGAirport::numTaxiways() const
+{
+  loadTaxiways();
+  return mTaxiways.size();
+}
 
-    return 1;
+FGTaxiway* FGAirport::getTaxiwayByIndex(unsigned int aIndex) const
+{
+  loadTaxiways();
+  assert(aIndex >= 0 && aIndex < mTaxiways.size());
+  return mTaxiways[aIndex];
 }
 
+unsigned int FGAirport::numPavements() const
+{
+  loadTaxiways();
+  return mPavements.size();
+}
 
-// save the data in gdbm format
-bool FGAirportsUtil::dump_mk4( const string& file ) {
+FGPavement* FGAirport::getPavementByIndex(unsigned int aIndex) const
+{
+  loadTaxiways();
+  assert(aIndex >= 0 && aIndex < mPavements.size());
+  return mPavements[aIndex];
+}
 
-    // open database for writing
-    c4_Storage storage( file.c_str(), true );
+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);
+}
 
-    // need to do something about error handling here!
+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);
+}
 
-    // define the properties
-    c4_StringProp pID ("ID");
-    c4_FloatProp pLon ("Longitude");
-    c4_FloatProp pLat ("Latitude");
-    c4_FloatProp pElev ("Elevation");
+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());
+}
 
-    // Start with an empty view of the proper structure.
-    c4_View vAirport =
-       storage.GetAs("airport[ID:S,Longitude:F,Latitude:F,Elevation:F]");
+FGAirport::HardSurfaceFilter::HardSurfaceFilter(double minLengthFt) :
+  mMinLengthFt(minLengthFt)
+{
+}
+      
+bool FGAirport::HardSurfaceFilter::passAirport(FGAirport* aApt) const
+{
+  return aApt->hasHardRunwayOfLengthFt(mMinLengthFt);
+}
 
-    c4_Row row;
+FGAirport* FGAirport::findByIdent(const std::string& aIdent)
+{
+  FGPositionedRef r;
+  PortsFilter 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());
+}
 
-    const_iterator current = airports.begin();
-    const_iterator end = airports.end();
-    while ( current != end ) {
-       // add each airport record
-       cout << "out -> " << current->id << endl;
-       pID (row) = current->id.c_str();
-       pLon (row) = current->longitude;
-       pLat (row) = current->latitude;
-       pElev (row) = current->elevation;
-       vAirport.Add(row);
+FGAirport* FGAirport::getByIdent(const std::string& aIdent)
+{
+  FGPositionedRef r;
+  PortsFilter 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());
+}
 
-       ++current;
+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);
+}
+
+// find basic airport location info from airport database
+const FGAirport *fgFindAirportID( const string& id)
+{
+    if ( id.empty() ) {
+        return NULL;
     }
+    
+    return FGAirport::findByIdent(id);
+}
 
-    // commit our changes
-    storage.Commit();
+void FGAirport::loadRunways() const
+{
+  if (mRunwaysLoaded) {
+    return; // already loaded, great
+  }
+  
+  mRunwaysLoaded = true;
+  loadSceneryDefintions();
+}
 
-    return true;
+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);
+  }
+}
 
-// search for the specified id
-bool
-FGAirportsUtil::search( const string& id, FGAirport* a ) const
+void FGAirport::readThresholdData(SGPropertyNode* aRoot)
 {
-    const_iterator it = airports.find( FGAirport(id) );
-    if ( it != airports.end() )
-    {
-       *a = *it;
-       return true;
-    }
-    else
-    {
-       return false;
-    }
+  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
 }
 
-
-FGAirport
-FGAirportsUtil::search( const string& id ) const
+void FGAirport::processThreshold(SGPropertyNode* aThreshold)
 {
-    FGAirport a;
-    this->search( id, &a );
-    return a;
+  // 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);
+}
 
-// Destructor
-FGAirportsUtil::~FGAirportsUtil( void ) {
+// get airport elevation
+double fgGetAirportElev( const string& id )
+{
+    const FGAirport *a=fgFindAirportID( id);
+    if (a) {
+        return a->getElevation();
+    } else {
+        return -9999.0;
+    }
 }
 
 
+// get airport position
+SGGeod fgGetAirportPos( const string& id )
+{
+    const FGAirport *a = fgFindAirportID( id);
+
+    if (a) {
+        return SGGeod::fromDegM(a->getLongitude(), a->getLatitude(), a->getElevation());
+    } else {
+        return SGGeod::fromDegM(0.0, 0.0, -9999.0);
+    }
+}