src/Navaids/navdb.cxx

   1 // navdb.cxx -- top level navaids management routines
   2 //
   3 // Written by Curtis Olson, started May 2004.
   4 //
   5 // Copyright (C) 2004  Curtis L. Olson - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include "navdb.hxx"
  28
  29 #include <simgear/compiler.h>
  30 #include <simgear/debug/logstream.hxx>
  31 #include <simgear/math/sg_geodesy.hxx>
  32 #include <simgear/misc/strutils.hxx>
  33 #include <simgear/misc/sg_path.hxx>
  34 #include <simgear/structure/exception.hxx>
  35 #include <simgear/misc/sgstream.hxx>
  36 #include <simgear/props/props_io.hxx>
  37 #include <simgear/sg_inlines.h>
  38
  39 #include "navrecord.hxx"
  40 #include "navlist.hxx"
  41 #include <Main/globals.hxx>
  42 #include <Navaids/markerbeacon.hxx>
  43 #include <Airports/simple.hxx>
  44 #include <Airports/runways.hxx>
  45 #include <Airports/xmlloader.hxx>
  46 #include <Main/fg_props.hxx>
  47 #include <Navaids/NavDataCache.hxx>
  48
  49 using std::string;
  50 using std::vector;
  51
  52 static FGPositioned::Type
  53 mapRobinTypeToFGPType(int aTy)
  54 {
  55   switch (aTy) {
  56  // case 1:
  57   case 2: return FGPositioned::NDB;
  58   case 3: return FGPositioned::VOR;
  59   case 4: return FGPositioned::ILS;
  60   case 5: return FGPositioned::LOC;
  61   case 6: return FGPositioned::GS;
  62   case 7: return FGPositioned::OM;
  63   case 8: return FGPositioned::MM;
  64   case 9: return FGPositioned::IM;
  65   case 12:
  66   case 13: return FGPositioned::DME;
  67   case 99: return FGPositioned::INVALID; // end-of-file code
  68   default:
  69     throw sg_range_exception("Got a nav.dat type we don't recognize", "FGNavRecord::createFromStream");
  70   }
  71 }
  72
  73 static bool autoAlignLocalizers = false;
  74 static double autoAlignThreshold = 0.0;
  75
  76 /**
  77  * Given a runway, and proposed localiser data (ident, positioned and heading),
  78  * precisely align the localiser with the actual runway heading, providing the
  79  * difference between the localiser course and runway heading is less than a
  80  * threshold. (To allow for localizers such as Kai-Tek requiring a turn on final).
  81  *
  82  * The positioned and heading argument are modified if changes are made.
  83  */
  84 void alignLocaliserWithRunway(FGRunway* rwy, const string& ident, SGGeod& pos, double& heading)
  85 {
  86   assert(rwy);
  87   // find the distance from the threshold to the localizer
  88   double dist = SGGeodesy::distanceM(pos, rwy->threshold());
  89
  90   // back project that distance along the runway center line
  91   SGGeod newPos = rwy->pointOnCenterline(dist);
  92
  93   double hdg_diff = heading - rwy->headingDeg();
  94   SG_NORMALIZE_RANGE(hdg_diff, -180.0, 180.0);
  95
  96   if ( fabs(hdg_diff) <= autoAlignThreshold ) {
  97     pos = SGGeod::fromGeodFt(newPos, pos.getElevationFt());
  98     heading = rwy->headingDeg();
  99   } else {
 100     SG_LOG(SG_NAVAID, SG_DEBUG, "localizer:" << ident << ", aligning with runway "
 101            << rwy->ident() << " exceeded heading threshold");
 102   }
 103 }
 104
 105 static double defaultNavRange(const string& ident, FGPositioned::Type type)
 106 {
 107   // Ranges are included with the latest data format, no need to
 108   // assign our own defaults, unless the range is not set for some
 109   // reason.
 110   SG_LOG(SG_NAVAID, SG_DEBUG, "navaid " << ident << " has no range set, using defaults");
 111   switch (type) {
 112     case FGPositioned::NDB:
 113     case FGPositioned::VOR:
 114       return FG_NAV_DEFAULT_RANGE;
 115
 116     case FGPositioned::LOC:
 117     case FGPositioned::ILS:
 118     case FGPositioned::GS:
 119       return FG_LOC_DEFAULT_RANGE;
 120
 121     case FGPositioned::DME: return FG_DME_DEFAULT_RANGE;
 122     default: return FG_LOC_DEFAULT_RANGE;
 123   }
 124 }
 125
 126
 127 namespace flightgear
 128 {
 129
 130 static PositionedID readNavFromStream(std::istream& aStream,
 131                                         FGPositioned::Type type = FGPositioned::INVALID)
 132 {
 133   NavDataCache* cache = NavDataCache::instance();
 134
 135   int rawType;
 136   aStream >> rawType;
 137   if (aStream.eof() || (rawType == 99)) {
 138     return 0; // happens with, eg, carrier_nav.dat
 139   }
 140
 141   double lat, lon, elev_ft, multiuse;
 142   int freq, range;
 143   std::string name, ident;
 144   aStream >> lat >> lon >> elev_ft >> freq >> range >> multiuse >> ident;
 145   getline(aStream, name);
 146
 147   SGGeod pos(SGGeod::fromDegFt(lon, lat, elev_ft));
 148   name = simgear::strutils::strip(name);
 149
 150 // the type can be forced by our caller, but normally we use th value
 151 // supplied in the .dat file
 152   if (type == FGPositioned::INVALID) {
 153     type = mapRobinTypeToFGPType(rawType);
 154   }
 155   if (type == FGPositioned::INVALID) {
 156     return 0;
 157   }
 158
 159   if ((type >= FGPositioned::OM) && (type <= FGPositioned::IM)) {
 160     AirportRunwayPair arp(cache->findAirportRunway(name));
 161     if (arp.second && (elev_ft < 0.01)) {
 162     // snap to runway elevation
 163       FGPositioned* runway = cache->loadById(arp.second);
 164       assert(runway);
 165       pos.setElevationFt(runway->geod().getElevationFt());
 166     }
 167
 168     return cache->insertNavaid(type, string(), name, pos, 0, 0, 0,
 169                                arp.first, arp.second);
 170   }
 171
 172   if (range < 0.01) {
 173     range = defaultNavRange(ident, type);
 174   }
 175
 176   AirportRunwayPair arp;
 177   FGRunway* runway = NULL;
 178
 179   // FIXME - also relate DMEs, but only ILS/LOC DMEs - need a heuristic
 180   // on the DME naming string
 181   if ((type >= FGPositioned::ILS) && (type <= FGPositioned::GS)) {
 182     arp = cache->findAirportRunway(name);
 183     if (arp.second) {
 184       runway = static_cast<FGRunway*>(cache->loadById(arp.second));
 185       assert(runway);
 186 #if 0
 187       // code is disabled since it's causing some problems, see
 188       // http://code.google.com/p/flightgear-bugs/issues/detail?id=926
 189       if (elev_ft < 0.01) {
 190         // snap to runway elevation
 191         pos.setElevationFt(runway->geod().getElevationFt());
 192       }
 193 #endif
 194     } // of found runway in the DB
 195   } // of type is runway-related
 196
 197   bool isLoc = (type == FGPositioned::ILS) || (type == FGPositioned::LOC);
 198   if (runway && autoAlignLocalizers && isLoc) {
 199     alignLocaliserWithRunway(runway, ident, pos, multiuse);
 200   }
 201
 202   // silently multiply adf frequencies by 100 so that adf
 203   // vs. nav/loc frequency lookups can use the same code.
 204   if (type == FGPositioned::NDB) {
 205     freq *= 100;
 206   }
 207
 208   PositionedID r = cache->insertNavaid(type, ident, name, pos, freq, range, multiuse,
 209                              arp.first, arp.second);
 210
 211   if (isLoc) {
 212     cache->setRunwayILS(arp.second, r);
 213   }
 214
 215   return r;
 216 }
 217
 218 // load and initialize the navigational databases
 219 bool navDBInit(const SGPath& path)
 220 {
 221     sg_gzifstream in( path.str() );
 222     if ( !in.is_open() ) {
 223         SG_LOG( SG_NAVAID, SG_ALERT, "Cannot open file: " << path.str() );
 224       return false;
 225     }
 226
 227   autoAlignLocalizers = fgGetBool("/sim/navdb/localizers/auto-align", true);
 228   autoAlignThreshold = fgGetDouble( "/sim/navdb/localizers/auto-align-threshold-deg", 5.0 );
 229
 230     // skip first two lines
 231     in >> skipeol;
 232     in >> skipeol;
 233
 234     while (!in.eof()) {
 235       readNavFromStream(in);
 236       in >> skipcomment;
 237     } // of stream data loop
 238
 239   return true;
 240 }
 241
 242
 243 bool loadCarrierNav(const SGPath& path)
 244 {
 245     SG_LOG( SG_NAVAID, SG_INFO, "opening file: " << path.str() );
 246     sg_gzifstream incarrier( path.str() );
 247
 248     if ( !incarrier.is_open() ) {
 249         SG_LOG( SG_NAVAID, SG_ALERT, "Cannot open file: " << path.str() );
 250       return false;
 251     }
 252
 253     while ( ! incarrier.eof() ) {
 254       // force the type to be MOBILE_TACAN
 255       readNavFromStream(incarrier, FGPositioned::MOBILE_TACAN);
 256     } // end while
 257
 258   return true;
 259 }
 260
 261 bool loadTacan(const SGPath& path, FGTACANList *channellist)
 262 {
 263     SG_LOG( SG_NAVAID, SG_INFO, "opening file: " << path.str() );
 264     sg_gzifstream inchannel( path.str() );
 265
 266     if ( !inchannel.is_open() ) {
 267         SG_LOG( SG_NAVAID, SG_ALERT, "Cannot open file: " << path.str() );
 268       return false;
 269     }
 270
 271     // skip first line
 272     inchannel >> skipeol;
 273     while ( ! inchannel.eof() ) {
 274         FGTACANRecord *r = new FGTACANRecord;
 275         inchannel >> (*r);
 276         channellist->add ( r );
 277
 278     } // end while
 279
 280     return true;
 281 }
 282
 283 } // of namespace flightgear