src/Navaids/navrecord.cxx

   1 // navrecord.cxx -- generic vor/dme/ndb class
   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 <istream>
  28
  29 #include <simgear/misc/sgstream.hxx>
  30 #include <simgear/structure/exception.hxx>
  31 #include <simgear/misc/strutils.hxx>
  32 #include <simgear/debug/logstream.hxx>
  33
  34 #include "Navaids/navrecord.hxx"
  35 #include "Airports/simple.hxx"
  36 #include "Airports/runways.hxx"
  37 #include "Main/fg_props.hxx"
  38
  39 FGNavRecord::FGNavRecord(Type aTy, const std::string& aIdent,
  40   const std::string& aName, const SGGeod& aPos,
  41   int aFreq, int aRange, double aMultiuse) :
  42   FGPositioned(aTy, aIdent, aPos),
  43   freq(aFreq),
  44   range(aRange),
  45   multiuse(aMultiuse),
  46   name(aName),
  47   serviceable(true),
  48   trans_ident(aIdent)
  49 {
  50   initAirportRelation();
  51
  52   // Ranges are included with the latest data format, no need to
  53   // assign our own defaults, unless the range is not set for some
  54   // reason.
  55   if (range < 0.1) {
  56     SG_LOG(SG_GENERAL, SG_WARN, "navaid " << ident() << " has no range set, using defaults");
  57     switch (type()) {
  58     case NDB:
  59     case VOR:
  60       range = FG_NAV_DEFAULT_RANGE;
  61       break;
  62
  63     case LOC:
  64     case ILS:
  65     case GS:
  66       range = FG_LOC_DEFAULT_RANGE;
  67       break;
  68
  69     case DME:
  70       range = FG_DME_DEFAULT_RANGE;
  71       break;
  72
  73     default:
  74       range = FG_LOC_DEFAULT_RANGE;
  75     }
  76   }
  77
  78 }
  79
  80 SGVec3d FGNavRecord::get_cart() const
  81 {
  82   return SGVec3d::fromGeod(geod());
  83 }
  84
  85
  86 static FGPositioned::Type
  87 mapRobinTypeToFGPType(int aTy)
  88 {
  89   switch (aTy) {
  90  // case 1:
  91   case 2: return FGPositioned::NDB;
  92   case 3: return FGPositioned::VOR;
  93   case 4: return FGPositioned::LOC;
  94   case 5: return FGPositioned::ILS;
  95   case 6: return FGPositioned::GS;
  96   case 7: return FGPositioned::OM;
  97   case 8: return FGPositioned::MM;
  98   case 9: return FGPositioned::IM;
  99   case 12:
 100   case 13: return FGPositioned::DME;
 101   case 99: return FGPositioned::INVALID; // end-of-file code
 102   default:
 103     throw sg_range_exception("Got a nav.dat type we don't recgonize", "FGNavRecord::createFromStream");
 104   }
 105 }
 106
 107 FGNavRecord* FGNavRecord::createFromStream(std::istream& aStream)
 108 {
 109   int rawType;
 110   aStream >> rawType;
 111   if (aStream.eof()) {
 112     return NULL; // happens with, eg, carrier_nav.dat
 113   }
 114
 115   Type type = mapRobinTypeToFGPType(rawType);
 116   if (type == INVALID) return NULL;
 117
 118   double lat, lon, elev_ft, multiuse;
 119   int freq, range;
 120   std::string apt_id, name, ident;
 121   aStream >> lat >> lon >> elev_ft >> freq >> range >> multiuse >> ident;
 122   getline(aStream, name);
 123
 124   // silently multiply adf frequencies by 100 so that adf
 125   // vs. nav/loc frequency lookups can use the same code.
 126   if (type == NDB) {
 127     freq *= 100;
 128   }
 129
 130   FGNavRecord* result = new FGNavRecord(type, ident,
 131     simgear::strutils::strip(name), SGGeod::fromDegFt(lon, lat, elev_ft),
 132     freq, range, multiuse);
 133
 134   return result;
 135 }
 136
 137 void FGNavRecord::initAirportRelation()
 138 {
 139   if (type() < ILS || type() > IM) {
 140     return; // not airport-located
 141   }
 142
 143   vector<string> parts = simgear::strutils::split(name);
 144   apt_id = parts[0];
 145   const FGAirport* apt = fgFindAirportID(apt_id);
 146
 147   if (!apt) {
 148     SG_LOG(SG_GENERAL, SG_WARN, "navaid " << ident() << " associated with bogus airport ID:" << apt_id);
 149     return;
 150   }
 151
 152   // fudge elevation to the field elevation if it's not specified
 153   if (fabs(elevation()) < 0.01) {
 154     mPosition.setElevationFt(apt->getElevation());
 155   }
 156
 157   // align localizers with their runway
 158   if ((type() == ILS) || (type() == LOC)) {
 159     if (!fgGetBool("/sim/navdb/localizers/auto-align", true)) {
 160       return;
 161     }
 162
 163     if (parts.size() < 2) {
 164       SG_LOG(SG_GENERAL, SG_ALERT, "can't parse navaid " << ident()
 165               << " name for airport/runway:" << name);
 166       return;
 167     }
 168
 169      double threshold
 170             = fgGetDouble( "/sim/navdb/localizers/auto-align-threshold-deg",
 171                            5.0 );
 172     FGRunway* runway = apt->getRunwayByIdent(parts[1]);
 173     alignLocaliserWithRunway(runway, threshold);
 174   }
 175 }
 176
 177 void FGNavRecord::alignLocaliserWithRunway(FGRunway* aRunway, double aThreshold)
 178 {
 179 // find the distance from the threshold to the localizer
 180   SGGeod runwayThreshold(aRunway->threshold());
 181   double dist, az1, az2;
 182   SGGeodesy::inverse(mPosition, runwayThreshold, az1, az2, dist);
 183
 184 // back project that distance along the runway center line
 185   SGGeod newPos = aRunway->pointOnCenterline(dist);
 186
 187   double hdg_diff = get_multiuse() - aRunway->headingDeg();
 188
 189   // clamp to [-180.0 ... 180.0]
 190   if ( hdg_diff < -180.0 ) {
 191       hdg_diff += 360.0;
 192   } else if ( hdg_diff > 180.0 ) {
 193       hdg_diff -= 360.0;
 194   }
 195
 196   if ( fabs(hdg_diff) <= aThreshold ) {
 197     mPosition = newPos;
 198     set_multiuse( aRunway->headingDeg() );
 199   } else {
 200     SG_LOG(SG_GENERAL, SG_WARN, "localizer:" << ident() << ", aligning with runway "
 201       << aRunway->ident() << " exceeded heading threshold");
 202   }
 203 }
 204
 205 FGTACANRecord::FGTACANRecord(void) :
 206     channel(""),
 207     freq(0)
 208
 209 {
 210 }
 211
 212 std::istream&
 213 operator >> ( std::istream& in, FGTACANRecord& n )
 214 {
 215     in >> n.channel >> n.freq ;
 216     //getline( in, n.name );
 217
 218     return in;
 219 }