]> git.mxchange.org Git - flightgear.git/blobdiff - src/Navaids/navlist.cxx
Prepare and implement reinit methods for instruments
[flightgear.git] / src / Navaids / navlist.cxx
index 44c830166bf7937aebc0d31a52deb61fd87e8021..a2bdcb082bd7fb088d205684d573e23ea105142c 100644 (file)
@@ -2,7 +2,7 @@
 //
 // Written by Curtis Olson, started April 2000.
 //
-// Copyright (C) 2000  Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 2000  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
@@ -16,7 +16,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$
 
 #  include <config.h>
 #endif
 
+#include <boost/foreach.hpp>
+#include <algorithm>
+
 #include <simgear/debug/logstream.hxx>
-#include <simgear/misc/sgstream.hxx>
 #include <simgear/math/sg_geodesy.hxx>
+#include <simgear/sg_inlines.h>
 
 #include "navlist.hxx"
 
+#include <Airports/runways.hxx>
 
-FGNavList *current_navlist;
+using std::string;
 
+namespace { // anonymous
 
-// Constructor
-FGNavList::FGNavList( void ) {
+class NavRecordDistanceSortPredicate
+{
+public:
+  NavRecordDistanceSortPredicate( const SGGeod & position ) :
+  _position(SGVec3d::fromGeod(position)) {}
+  
+  bool operator()( const nav_rec_ptr & n1, const nav_rec_ptr & n2 )
+  {
+    if( n1 == NULL || n2 == NULL ) return false;
+    return distSqr(n1->cart(), _position) < distSqr(n2->cart(), _position);
+  }
+private:
+  SGVec3d _position;
+  
+};
+
+} // of anonymous namespace
+
+// FGNavList ------------------------------------------------------------------
+
+
+FGNavList::TypeFilter::TypeFilter(const FGPositioned::Type type)
+{
+  if (type == FGPositioned::INVALID) {
+    _mintype = FGPositioned::VOR;
+    _maxtype = FGPositioned::GS;
+  } else {
+    _mintype = _maxtype = type;
+  }
 }
 
 
-// Destructor
-FGNavList::~FGNavList( void ) {
+FGNavList::FGNavList( void )
+{
 }
 
 
-// load the navaids and build the map
-bool FGNavList::init( SGPath path ) {
-
+FGNavList::~FGNavList( void )
+{
+    nav_list_type navlist = navaids.begin()->second;
     navaids.erase( navaids.begin(), navaids.end() );
+}
 
-    sg_gzifstream in( path.str() );
-    if ( !in.is_open() ) {
-        SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << path.str() );
-        exit(-1);
-    }
 
-    // read in each line of the file
+// load the navaids and build the map
+bool FGNavList::init()
+{
+    // No need to delete the original navaid structures
+    // since we're using an SGSharedPointer
+    nav_list_type navlist = navaids.begin()->second;
+    navaids.erase( navaids.begin(), navaids.end() );
+    return true;
+}
 
-    in >> skipeol;
-    in >> skipcomment;
+// add an entry to the lists
+bool FGNavList::add( FGNavRecord *n )
+{
+    navaids[n->get_freq()].push_back(n);
+    return true;
+}
 
-    // double min = 100000;
-    // double max = 0;
+FGNavRecord *FGNavList::findByFreq( double freq, const SGGeod& position)
+{
+    const nav_list_type& stations = navaids[(int)(freq*100.0 + 0.5)];
+    SG_LOG( SG_INSTR, SG_DEBUG, "findbyFreq " << freq << " size " << stations.size()  );
+    return findNavFromList( position, stations );
+}
 
-#ifdef __MWERKS__
-    char c = 0;
-    while ( in.get(c) && c != '\0'  ) {
-        in.putback(c);
-#else
-    while ( ! in.eof() ) {
-#endif
+nav_list_type FGNavList::findAllByFreq( double freq, const SGGeod& position, const FGPositioned::Type type)
+{
+  nav_list_type stations;
+  TypeFilter filter(type);
+  
+  BOOST_FOREACH(nav_rec_ptr nav, navaids[(int)(freq*100.0 + 0.5)]) {
+    if (filter.pass(nav.ptr())) {
+      stations.push_back(nav);
+    }
+  }
+  
+  NavRecordDistanceSortPredicate sortPredicate( position );
+  std::sort( stations.begin(), stations.end(), sortPredicate );
+  return stations;
+}
 
-        FGNav *n = new FGNav;
-        in >> (*n);
-        if ( n->get_type() == '[' ) {
-            break;
-        }
 
-       /* cout << "id = " << n.get_ident() << endl;
-       cout << " type = " << n.get_type() << endl;
-       cout << " lon = " << n.get_lon() << endl;
-       cout << " lat = " << n.get_lat() << endl;
-       cout << " elev = " << n.get_elev() << endl;
-       cout << " freq = " << n.get_freq() << endl;
-       cout << " range = " << n.get_range() << endl << endl; */
-
-        navaids      [n->get_freq() ].push_back(n);
-        ident_navaids[n->get_ident()].push_back(n);
-               
-        in >> skipcomment;
-
-       /* if ( n.get_type() != 'N' ) {
-           if ( n.get_freq() < min ) {
-               min = n.get_freq();
-           }
-           if ( n.get_freq() > max ) {
-               max = n.get_freq();
-           }
-       } */
+// Given an Ident and optional frequency, return the first matching
+// station.
+const nav_list_type FGNavList::findByIdentAndFreq(const string& ident, const double freq, const FGPositioned::Type type )
+{
+  FGPositionedRef cur;
+  TypeFilter filter(type);
+  nav_list_type reply;
+
+  cur = FGPositioned::findNextWithPartialId(cur, ident, &filter);
+  
+  int f = (int)(freq*100.0 + 0.5);
+  while (cur) {
+    FGNavRecord* nav = static_cast<FGNavRecord*>(cur.ptr());
+    if ( f <= 0.0 || nav->get_freq() == f) {
+        reply.push_back( nav );
     }
+    
+    cur = FGPositioned::findNextWithPartialId(cur, ident, &filter);
+  }
 
-    // cout << "min freq = " << min << endl;
-    // cout << "max freq = " << max << endl;
-
-    return true;
+  return reply;
 }
 
-
-// Query the database for the specified frequency.  It is assumed that
-// there will be multiple stations with matching frequencies so a
-// position must be specified.  Lon and lat are in degrees, elev is in
-// meters.
-FGNav *FGNavList::findByFreq( double freq, double lon, double lat, double elev )
+// Given an Ident and optional frequency and type ,
+// return a list of matching stations sorted by distance to the given position
+const nav_list_type FGNavList::findByIdentAndFreq( const SGGeod & position,
+        const std::string& ident, const double freq, const FGPositioned::Type type )
 {
-    nav_list_type stations = navaids[(int)(freq*100.0 + 0.5)];
-    Point3D aircraft = sgGeodToCart( Point3D(lon, lat, elev) );
+    nav_list_type reply = findByIdentAndFreq( ident, freq, type );
+    NavRecordDistanceSortPredicate sortPredicate( position );
+    std::sort( reply.begin(), reply.end(), sortPredicate );
 
-    return findNavFromList( aircraft, stations );
+    return reply;
 }
 
+// discount navids if they conflict with another on the same frequency
+// this only applies to navids associated with opposite ends of a runway,
+// with matching frequencies.
+static bool navidUsable(FGNavRecord* aNav, const SGGeod &aircraft)
+{
+  FGRunway* r(aNav->runway());
+  if (!r || !r->reciprocalRunway()) {
+    return true;
+  }
+  
+// check if the runway frequency is paired
+  FGNavRecord* locA = r->ILS();
+  FGNavRecord* locB = r->reciprocalRunway()->ILS();
+  
+  if (!locA || !locB || (locA->get_freq() != locB->get_freq())) {
+    return true; // not paired, ok
+  }
+  
+// okay, both ends have an ILS, and they're paired. We need to select based on
+// aircraft position. What we're going to use is *runway* (not navid) position,
+// ie whichever runway end we are closer too. This makes back-course / missed
+// approach behaviour incorrect, but that's the price we accept.
+  double crs = SGGeodesy::courseDeg(aircraft, r->geod());
+  double hdgDiff = crs - r->headingDeg();
+  SG_NORMALIZE_RANGE(hdgDiff, -180.0, 180.0);  
+  return (fabs(hdgDiff) < 90.0);
+}
 
-FGNav *FGNavList::findByIdent( const char* ident,
-                               const double lon, const double lat )
+// Given a point and a list of stations, return the closest one to
+// the specified point.
+FGNavRecord* FGNavList::findNavFromList( const SGGeod &aircraft,
+                                  const nav_list_type &stations )
 {
-    nav_list_type stations = ident_navaids[ident];
-    Point3D aircraft = sgGeodToCart( Point3D(lon, lat, 0.0) );
+    FGNavRecord *nav = NULL;
+    double d2;                  // in meters squared
+    double min_dist
+        = FG_NAV_MAX_RANGE*SG_NM_TO_METER*FG_NAV_MAX_RANGE*SG_NM_TO_METER;
+    SGVec3d aircraftCart = SGVec3d::fromGeod(aircraft);
+    
+    nav_list_const_iterator it;
+    nav_list_const_iterator end = stations.end();
+    // find the closest station within a sensible range (FG_NAV_MAX_RANGE)
+    for ( it = stations.begin(); it != end; ++it ) {
+        FGNavRecord *station = *it;
+        d2 = distSqr(station->cart(), aircraftCart);
+        if ( d2 > min_dist || !navidUsable(station, aircraft)) {
+          continue;
+        }
+        
+        min_dist = d2;
+        nav = station;
+    }
 
-    return findNavFromList( aircraft, stations );
+    return nav;
 }
 
+// Given a frequency, return the first matching station.
+FGNavRecord *FGNavList::findStationByFreq( double freq )
+{
+    const nav_list_type& stations = navaids[(int)(freq*100.0 + 0.5)];
+
+    SG_LOG( SG_INSTR, SG_DEBUG, "findStationByFreq " << freq << " size " << stations.size()  );
 
-// Given an Ident and optional freqency, return the first matching
-// station.
-FGNav *FGNavList::findByIdentAndFreq( const char* ident, const double freq )
-{
-    nav_list_type stations = ident_navaids[ident];
-
-    if ( freq > 0.0 ) {
-        // sometimes there can be duplicated idents.  If a freq is
-        // specified, use it to refine the search.
-        int f = (int)(freq*100.0 + 0.5);
-        for ( unsigned int i = 0; i < stations.size(); ++i ) {
-            if ( f == stations[i]->get_freq() ) {
-                return stations[i];
-            }
-        }
-    } else {
+    if (!stations.empty()) {
         return stations[0];
     }
-
     return NULL;
 }
 
 
-// Given a point and a list of stations, return the closest one to the
-// specified point.
-FGNav *FGNavList::findNavFromList( const Point3D &aircraft, 
-                                   const nav_list_type &stations )
+
+// FGTACANList ----------------------------------------------------------------
+
+FGTACANList::FGTACANList( void )
 {
-    FGNav *nav = NULL;
-    Point3D station;
-    double d2;
-    double min_dist = 999999999.0;
+}
+
+
+FGTACANList::~FGTACANList( void )
+{
+}
 
-    // prime the pump with info from stations[0]
-    if ( stations.size() > 0 ) {
-        nav = stations[0];
-       station = Point3D( nav->get_x(), nav->get_y(), nav->get_z());
-       min_dist = aircraft.distance3Dsquared( station );
-    }
 
-    // check if any of the remaining stations are closer
-    for ( unsigned int i = 1; i < stations.size(); ++i ) {
-       // cout << "testing " << current->get_ident() << endl;
-       station = Point3D( stations[i]->get_x(),
-                           stations[i]->get_y(),
-                           stations[i]->get_z() );
+bool FGTACANList::init()
+{
+    return true;
+}
 
-       d2 = aircraft.distance3Dsquared( station );
 
-       // cout << "  dist = " << sqrt(d)
-       //      << "  range = " << current->get_range() * SG_NM_TO_METER
-        //      << endl;
+// add an entry to the lists
+bool FGTACANList::add( FGTACANRecord *c )
+{
+    ident_channels[c->get_channel()].push_back(c);
+    return true;
+}
 
-        if ( d2 < min_dist ) {
-            min_dist = d2;
-            nav = stations[i];
-        }
-    }
 
-    return nav;
+// Given a TACAN Channel return the first matching frequency
+FGTACANRecord *FGTACANList::findByChannel( const string& channel )
+{
+    const tacan_list_type& stations = ident_channels[channel];
+    SG_LOG( SG_INSTR, SG_DEBUG, "findByChannel " << channel<< " size " << stations.size() );
+
+    if (!stations.empty()) {
+        return stations[0];
+    }
+    return NULL;
 }
+
+