]> git.mxchange.org Git - flightgear.git/blobdiff - src/Navaids/navlist.cxx
Fix bug 1227, cache thrash on Win.
[flightgear.git] / src / Navaids / navlist.cxx
index 6bbf59fa3c7f1475543d875b49391246f5a16b7b..822391e04d79d38cd928566f07c4c023decce286 100644 (file)
 #  include <config.h>
 #endif
 
+#include <cassert>
+#include <boost/foreach.hpp>
+#include <algorithm>
+
 #include <simgear/debug/logstream.hxx>
 #include <simgear/math/sg_geodesy.hxx>
 #include <simgear/sg_inlines.h>
 #include "navlist.hxx"
 
 #include <Airports/runways.hxx>
-
-#include <algorithm>
+#include <Navaids/NavDataCache.hxx>
+#include <Navaids/navrecord.hxx>
 
 using std::string;
 
-// FGNavList ------------------------------------------------------------------
+namespace { // anonymous
 
-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;
+  
+};
 
-FGNavList::~FGNavList( void )
+// 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.
+bool navidUsable(FGNavRecord* aNav, const SGGeod &aircraft)
 {
-    nav_list_type navlist = navaids.begin()->second;
-    navaids.erase( navaids.begin(), navaids.end() );
+  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);
 }
+  
+} // of anonymous namespace
+
+// FGNavList ------------------------------------------------------------------
 
 
-// load the navaids and build the map
-bool FGNavList::init()
+//------------------------------------------------------------------------------
+FGNavList::TypeFilter::TypeFilter(const FGPositioned::Type type)
 {
-    // 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;
+  if (type == FGPositioned::INVALID) {
+    _mintype = FGPositioned::NDB;
+    _maxtype = FGPositioned::GS;
+  } else {
+    _mintype = _maxtype = type;
+  }
 }
 
-// add an entry to the lists
-bool FGNavList::add( FGNavRecord *n )
+//------------------------------------------------------------------------------
+FGNavList::TypeFilter::TypeFilter( const FGPositioned::Type minType,
+                                   const FGPositioned::Type maxType ):
+  _mintype(minType),
+  _maxtype(maxType)
 {
-    navaids[n->get_freq()].push_back(n);
-    return true;
 }
 
-FGNavRecord *FGNavList::findByFreq( double freq, const SGGeod& position)
+//------------------------------------------------------------------------------
+bool FGNavList::TypeFilter::fromTypeString(const std::string& type)
 {
-    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 );
+  FGPositioned::Type t;
+  if(      type == "any"  ) t = FGPositioned::INVALID;
+  else if( type == "fix"  ) t = FGPositioned::FIX;
+  else if( type == "vor"  ) t = FGPositioned::VOR;
+  else if( type == "ndb"  ) t = FGPositioned::NDB;
+  else if( type == "ils"  ) t = FGPositioned::ILS;
+  else if( type == "dme"  ) t = FGPositioned::DME;
+  else if( type == "tacan") t = FGPositioned::TACAN;
+  else                      return false;
+
+  _mintype = _maxtype = t;
+
+  return true;
 }
 
-class TypeFilter : public FGPositioned::Filter
+/**
+ * Filter returning Tacan stations. Checks for both pure TACAN stations
+ * but also co-located VORTACs. This is done by searching for DMEs whose
+ * name indicates they are a TACAN or VORTAC; not a great solution.
+ */
+class TacanFilter : public FGNavList::TypeFilter
 {
 public:
-    TypeFilter( const FGPositioned::Type mintype, const FGPositioned::Type maxtype ) : _mintype(mintype), _maxtype(maxtype) {}
-
-  virtual FGPositioned::Type minType() const {
-    return _mintype;
-  }
-
-  virtual FGPositioned::Type maxType()  const {
-    return _maxtype;
+  TacanFilter() :
+    TypeFilter(FGPositioned::DME, FGPositioned::TACAN)
+  {
   }
-private:
-    FGPositioned::Type _mintype;
-    FGPositioned::Type _maxtype;
-};
-
-// Given an Ident and optional freqency, 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 == FGPositioned::INVALID ? FGPositioned::VOR : type,
-      type == FGPositioned::INVALID ? FGPositioned::NDB : 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 );
+  virtual bool pass(FGPositioned* pos) const
+  {
+    if (pos->type() == FGPositioned::TACAN) {
+      return true;
     }
     
-    cur = FGPositioned::findNextWithPartialId(cur, ident, &filter);
+    assert(pos->type() == FGPositioned::DME);
+    string::size_type loc1 = pos->name().find( "TACAN" );
+    string::size_type loc2 = pos->name().find( "VORTAC" );
+    return (loc1 != string::npos) || (loc2 != string::npos);
   }
+};
 
-  return reply;
+FGNavList::TypeFilter* FGNavList::locFilter()
+{
+  static TypeFilter tf(FGPositioned::ILS, FGPositioned::LOC);
+  return &tf;
 }
 
-class NavRecordDistanceSortPredicate
+FGNavList::TypeFilter* FGNavList::ndbFilter()
 {
-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;
+  static TypeFilter tf(FGPositioned::NDB);
+  return &tf;
+}
 
-};
+FGNavList::TypeFilter* FGNavList::navFilter()
+{
+  static TypeFilter tf(FGPositioned::VOR, FGPositioned::LOC);
+  return &tf;
+}
 
-// Given an Ident and optional freqency 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 )
+FGNavList::TypeFilter* FGNavList::tacanFilter()
 {
-    nav_list_type reply = findByIdentAndFreq( ident, freq, type );
-    NavRecordDistanceSortPredicate sortPredicate( position );
-    std::sort( reply.begin(), reply.end(), sortPredicate );
+  static TacanFilter tf;
+  return &tf;
+}
 
-    return reply;
+FGNavList::TypeFilter* FGNavList::carrierFilter()
+{
+  static TypeFilter tf(FGPositioned::MOBILE_TACAN);
+  return &tf;
 }
 
-// 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)
+FGNavRecordRef FGNavList::findByFreq( double freq,
+                                      const SGGeod& position,
+                                      TypeFilter* filter )
 {
-  FGRunway* r(aNav->runway());
-  if (!r || !r->reciprocalRunway()) {
-    return true;
+  flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
+  int freqKhz = static_cast<int>(freq * 100 + 0.5);
+  PositionedIDVec stations(cache->findNavaidsByFreq(freqKhz, position, filter));
+  if (stations.empty()) {
+    return NULL;
   }
   
-// 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
+// now walk the (sorted) results list to find a usable, in-range navaid
+  SGVec3d acCart(SGVec3d::fromGeod(position));
+  double min_dist
+    = FG_NAV_MAX_RANGE*SG_NM_TO_METER*FG_NAV_MAX_RANGE*SG_NM_TO_METER;
+    
+  BOOST_FOREACH(PositionedID id, stations) {
+    FGNavRecordRef station = FGPositioned::loadById<FGNavRecord>(id);
+    if (!filter->pass(station)) {
+      continue;
+    }
+    
+    double d2 = distSqr(station->cart(), acCart);
+    if (d2 > min_dist) {
+    // since results are sorted by proximity, as soon as we pass the
+    // distance cutoff we're done - fall out and return NULL
+      break;
+    }
+    
+    if (navidUsable(station, position)) {
+      return station;
+    }
   }
-  
-// 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);
+    
+// fell out of the loop, no usable match
+  return NULL;
 }
 
-// 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 )
+FGNavRecordRef FGNavList::findByFreq(double freq, TypeFilter* filter)
 {
-    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;
+  flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
+  int freqKhz = static_cast<int>(freq * 100 + 0.5);
+  PositionedIDVec stations(cache->findNavaidsByFreq(freqKhz, filter));
+  if (stations.empty()) {
+    return NULL;
+  }
+
+  BOOST_FOREACH(PositionedID id, stations) {
+    FGNavRecordRef station = FGPositioned::loadById<FGNavRecord>(id);
+    if (filter->pass(station)) {
+      return station;
     }
+  }
 
-    return nav;
+  return NULL;
 }
 
-// Given a frequency, return the first matching station.
-FGNavRecord *FGNavList::findStationByFreq( double freq )
+nav_list_type FGNavList::findAllByFreq( double freq, const SGGeod& position,
+                                       TypeFilter* filter)
 {
-    const nav_list_type& stations = navaids[(int)(freq*100.0 + 0.5)];
+  nav_list_type stations;
+  
+  flightgear::NavDataCache* cache = flightgear::NavDataCache::instance();
+  int freqKhz = static_cast<int>(freq * 1000 + 0.5);
+  PositionedIDVec ids(cache->findNavaidsByFreq(freqKhz, position, filter));
+  
+  BOOST_FOREACH(PositionedID id, ids) {
+    FGNavRecordRef station = FGPositioned::loadById<FGNavRecord>(id);
+    if (!filter->pass(station)) {
+      continue;
+    }
 
-    SG_LOG( SG_INSTR, SG_DEBUG, "findStationByFreq " << freq << " size " << stations.size()  );
+    stations.push_back(station);
+  }
+  
+  return stations;
+}
 
-    if (!stations.empty()) {
-        return stations[0];
+nav_list_type FGNavList::findByIdentAndFreq(const string& ident, const double freq,
+                                            TypeFilter* filter)
+{
+  nav_list_type reply;
+  int f = (int)(freq*100.0 + 0.5);
+  
+  FGPositionedList stations = FGPositioned::findAllWithIdent(ident, filter);
+  BOOST_FOREACH(FGPositionedRef ref, stations) {
+    FGNavRecord* nav = static_cast<FGNavRecord*>(ref.ptr());
+    if ( f <= 0.0 || nav->get_freq() == f) {
+      reply.push_back( nav );
     }
-    return NULL;
+  }
+
+  return reply;
 }
 
+// Given an Ident and optional frequency and type ,
+// return a list of matching stations sorted by distance to the given position
+nav_list_type FGNavList::findByIdentAndFreq( const SGGeod & position,
+        const std::string& ident, const double freq,
+                                            TypeFilter* filter)
+{
+    nav_list_type reply = findByIdentAndFreq( ident, freq, filter );
+    NavRecordDistanceSortPredicate sortPredicate( position );
+    std::sort( reply.begin(), reply.end(), sortPredicate );
 
+    return reply;
+}
 
 // FGTACANList ----------------------------------------------------------------
 
@@ -246,7 +323,7 @@ bool FGTACANList::add( FGTACANRecord *c )
 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() );
+    SG_LOG( SG_NAVAID, SG_DEBUG, "findByChannel " << channel<< " size " << stations.size() );
 
     if (!stations.empty()) {
         return stations[0];