]> git.mxchange.org Git - flightgear.git/blobdiff - src/Navaids/navlist.cxx
Interim windows build fix
[flightgear.git] / src / Navaids / navlist.cxx
index abf7e104cb1599b341513b10ec2bf66a30f915a2..9b0c911dee50c44c274532495c78113a9252fb5d 100644 (file)
@@ -1,8 +1,8 @@
-// navaids.cxx -- navaids management class
+// navlist.cxx -- navaids management class
 //
 // 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
 //
 // 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 <cassert>
+#include <boost/foreach.hpp>
+#include <algorithm>
+
 #include <simgear/debug/logstream.hxx>
-#include <simgear/misc/fgstream.hxx>
 #include <simgear/math/sg_geodesy.hxx>
+#include <simgear/sg_inlines.h>
 
 #include "navlist.hxx"
 
+#include <Airports/runways.hxx>
+#include <Navaids/NavDataCache.hxx>
+#include <Navaids/navrecord.hxx>
 
-FGNavList *current_navlist;
+using std::string;
 
+namespace { // anonymous
+
+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;
+  
+};
 
-// Constructor
-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)
+{
+  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 ------------------------------------------------------------------
 
-// Destructor
-FGNavList::~FGNavList( void ) {
+
+//------------------------------------------------------------------------------
+FGNavList::TypeFilter::TypeFilter(const FGPositioned::Type type)
+{
+  if (type == FGPositioned::INVALID) {
+    _mintype = FGPositioned::NDB;
+    _maxtype = FGPositioned::GS;
+  } else {
+    _mintype = _maxtype = type;
+  }
 }
 
+//------------------------------------------------------------------------------
+FGNavList::TypeFilter::TypeFilter( const FGPositioned::Type minType,
+                                   const FGPositioned::Type maxType ):
+  _mintype(minType),
+  _maxtype(maxType)
+{
+}
+
+//------------------------------------------------------------------------------
+bool FGNavList::TypeFilter::fromTypeString(const std::string& type)
+{
+  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;
 
-// load the navaids and build the map
-bool FGNavList::init( FGPath path ) {
-    FGNav n;
+  _mintype = _maxtype = t;
 
-    navaids.erase( navaids.begin(), navaids.end() );
+  return true;
+}
 
-    fg_gzifstream in( path.str() );
-    if ( !in.is_open() ) {
-        FG_LOG( FG_GENERAL, FG_ALERT, "Cannot open file: " << path.str() );
-        exit(-1);
+/**
+ * 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:
+  TacanFilter() :
+    TypeFilter(FGPositioned::DME, FGPositioned::TACAN)
+  {
+  }
+  
+  virtual bool pass(FGPositioned* pos) const
+  {
+    if (pos->type() == FGPositioned::TACAN) {
+      return true;
     }
+    
+    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);
+  }
+};
 
-    // read in each line of the file
+FGNavList::TypeFilter* FGNavList::locFilter()
+{
+  static TypeFilter tf(FGPositioned::ILS, FGPositioned::LOC);
+  return &tf;
+}
 
-    in >> skipeol;
-    in >> skipcomment;
+FGNavList::TypeFilter* FGNavList::ndbFilter()
+{
+  static TypeFilter tf(FGPositioned::NDB);
+  return &tf;
+}
+
+FGNavList::TypeFilter* FGNavList::navFilter()
+{
+  static TypeFilter tf(FGPositioned::VOR, FGPositioned::LOC);
+  return &tf;
+}
+
+FGNavList::TypeFilter* FGNavList::tacanFilter()
+{
+  static TacanFilter tf;
+  return &tf;
+}
 
-#ifdef __MWERKS__
+FGNavList::TypeFilter* FGNavList::mobileTacanFilter()
+{
+  static TypeFilter tf(FGPositioned::MOBILE_TACAN);
+  return &tf;
+}
 
-    char c = 0;
-    while ( in.get(c) && c != '\0' && n.get_type() != '[' ) {
-        in.putback(c);
-        in >> n;
-       if ( n.get_type() != '[' ) {
-           navaids[n.get_freq()].push_back(n);
-       }
-        in >> skipcomment;
+FGNavRecordRef FGNavList::findByFreq( double freq,
+                                      const SGGeod& position,
+                                      TypeFilter* filter )
+{
+  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;
+  }
+  
+// 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;
+    }
+  }
+    
+// fell out of the loop, no usable match
+  return NULL;
+}
+
+FGNavRecordRef FGNavList::findByFreq(double freq, TypeFilter* filter)
+{
+  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;
+  }
 
-#else
-
-    double min = 100000;
-    double max = 0;
-
-    while ( ! in.eof() && n.get_type() != '[' ) {
-        in >> n;
-       /* 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; */
-       if ( n.get_type() != '[' ) {
-           navaids[n.get_freq()].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();
-           }
-       }
+  BOOST_FOREACH(PositionedID id, stations) {
+    FGNavRecordRef station = FGPositioned::loadById<FGNavRecord>(id);
+    if (filter->pass(station)) {
+      return station;
     }
+  }
 
-    // cout << "min freq = " << min << endl;
-    // cout << "max freq = " << max << endl;
+  return NULL;
+}
 
-#endif
+nav_list_type FGNavList::findAllByFreq( double freq, const SGGeod& position,
+                                       TypeFilter* filter)
+{
+  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;
+    }
 
-    return true;
+    stations.push_back(station);
+  }
+  
+  return stations;
 }
 
+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 reply;
+}
 
-// query the database for the specified frequency, lon and lat are in
-// degrees, elev is in meters
-bool FGNavList::query( double lon, double lat, double elev, double freq,
-                      FGNav *n )
+// 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 stations = navaids[(int)(freq*100.0 + 0.5)];
+    nav_list_type reply = findByIdentAndFreq( ident, freq, filter );
+    NavRecordDistanceSortPredicate sortPredicate( position );
+    std::sort( reply.begin(), reply.end(), sortPredicate );
+
+    return reply;
+}
 
-    nav_list_iterator current = stations.begin();
-    nav_list_iterator last = stations.end();
+// FGTACANList ----------------------------------------------------------------
 
-    // double az1, az2, s;
-    Point3D aircraft = sgGeodToCart( Point3D(lon, lat, elev) );
-    Point3D station;
-    double d;
-    for ( ; current != last ; ++current ) {
-       // cout << "testing " << current->get_ident() << endl;
-       station = Point3D(current->get_x(), current->get_y(), current->get_z());
+FGTACANList::FGTACANList( void )
+{
+}
 
-       d = aircraft.distance3Dsquared( station );
 
-       // cout << "  dist = " << sqrt(d)
-       //      << "  range = " << current->get_range() * NM_TO_METER << endl;
-       if ( d < (current->get_range() * NM_TO_METER 
-                 * current->get_range() * NM_TO_METER * 5.0) ) {
-           // cout << "matched = " << current->get_ident() << endl;
-           *n = *current;
-           return true;
-       }
-    }
+FGTACANList::~FGTACANList( void )
+{
+}
 
-    return false;
+
+bool FGTACANList::init()
+{
+    return true;
+}
+
+
+// add an entry to the lists
+bool FGTACANList::add( FGTACANRecord *c )
+{
+    ident_channels[c->get_channel()].push_back(c);
+    return true;
 }
+
+
+// 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_NAVAID, SG_DEBUG, "findByChannel " << channel<< " size " << stations.size() );
+
+    if (!stations.empty()) {
+        return stations[0];
+    }
+    return NULL;
+}
+
+