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/misc/sg_path.hxx>
  31 #include <simgear/structure/exception.hxx>
  32 #include <simgear/debug/logstream.hxx>
  33 #include <simgear/sg_inlines.h>
  34 #include <simgear/props/props.hxx>
  35 #include <simgear/props/props_io.hxx>
  36
  37 #include <Navaids/navrecord.hxx>
  38 #include <Navaids/navdb.hxx>
  39 #include <Airports/runways.hxx>
  40 #include <Airports/simple.hxx>
  41 #include <Airports/xmlloader.hxx>
  42
  43 #include <Main/fg_props.hxx>
  44
  45 FGNavRecord::FGNavRecord(Type aTy, const std::string& aIdent,
  46   const std::string& aName, const SGGeod& aPos,
  47   int aFreq, int aRange, double aMultiuse) :
  48   FGPositioned(aTy, aIdent, aPos),
  49   freq(aFreq),
  50   range(aRange),
  51   multiuse(aMultiuse),
  52   _name(aName),
  53   mRunway(NULL),
  54   serviceable(true),
  55   trans_ident(aIdent)
  56 {
  57   initAirportRelation();
  58
  59   // Ranges are included with the latest data format, no need to
  60   // assign our own defaults, unless the range is not set for some
  61   // reason.
  62   if (range < 0.1) {
  63     SG_LOG(SG_GENERAL, SG_WARN, "navaid " << ident() << " has no range set, using defaults");
  64     switch (type()) {
  65     case NDB:
  66     case VOR:
  67       range = FG_NAV_DEFAULT_RANGE;
  68       break;
  69
  70     case LOC:
  71     case ILS:
  72     case GS:
  73       range = FG_LOC_DEFAULT_RANGE;
  74       break;
  75
  76     case DME:
  77       range = FG_DME_DEFAULT_RANGE;
  78       break;
  79
  80     default:
  81       range = FG_LOC_DEFAULT_RANGE;
  82     }
  83   }
  84
  85   init(true); // init FGPositioned (now position is adjusted)
  86 }
  87
  88 void FGNavRecord::initAirportRelation()
  89 {
  90   if ((type() < ILS) || (type() > GS)) {
  91     return; // not airport-located
  92   }
  93
  94   mRunway = getRunwayFromName(_name);
  95   if (!mRunway) {
  96     return;
  97   }
  98
  99   if (type() != GS) {
 100     readAirportSceneryData();
 101   }
 102
 103   // fudge elevation to the runway elevation if it's not specified
 104   if (fabs(elevation()) < 0.01) {
 105     mPosition.setElevationFt(mRunway->elevation());
 106   }
 107
 108   if (type() == ILS || type() == LOC) {
 109     mRunway->setILS(this);
 110   }
 111
 112   // align localizers with their runway
 113   if ((type() == ILS) || (type() == LOC)) {
 114     if (!fgGetBool("/sim/navdb/localizers/auto-align", true)) {
 115       return;
 116     }
 117
 118    double threshold
 119      = fgGetDouble( "/sim/navdb/localizers/auto-align-threshold-deg", 5.0 );
 120     alignLocaliserWithRunway(threshold);
 121   }
 122 }
 123
 124 void FGNavRecord::readAirportSceneryData()
 125 {
 126   // allow users to disable the scenery data in the short-term
 127   // longer term, this option can probably disappear
 128   if (!fgGetBool("/sim/use-scenery-airport-data")) {
 129     return;
 130   }
 131
 132   SGPath path;
 133   SGPropertyNode_ptr rootNode = new SGPropertyNode;
 134   if (!XMLLoader::findAirportData(mRunway->airport()->ident(), "ils", path)) {
 135     return;
 136   }
 137
 138   readProperties(path.str(), rootNode);
 139   SGPropertyNode* runwayNode, *ilsNode;
 140   for (int i=0; (runwayNode = rootNode->getChild("runway", i)) != NULL; ++i) {
 141     for (int j=0; (ilsNode = runwayNode->getChild("ils", j)) != NULL; ++j) {
 142       // must match on both nav-ident and runway ident, to support the following:
 143       // - runways with multiple distinct ILS installations (KEWD, for example)
 144       // - runways where both ends share the same nav ident (LFAT, for example)
 145       if ((ilsNode->getStringValue("nav-id") == ident()) &&
 146           (ilsNode->getStringValue("rwy") == mRunway->ident())) {
 147         processSceneryILS(ilsNode);
 148         return;
 149       }
 150     } // of ILS iteration
 151   } // of runway iteration
 152 }
 153
 154 void FGNavRecord::processSceneryILS(SGPropertyNode* aILSNode)
 155 {
 156   double hdgDeg = aILSNode->getDoubleValue("hdg-deg"),
 157     lon = aILSNode->getDoubleValue("lon"),
 158     lat = aILSNode->getDoubleValue("lat"),
 159     elevM = aILSNode->getDoubleValue("elev-m");
 160
 161   mPosition = SGGeod::fromDegM(lon, lat, elevM);
 162   multiuse = hdgDeg;
 163 }
 164
 165 void FGNavRecord::alignLocaliserWithRunway(double aThreshold)
 166 {
 167 // find the distance from the threshold to the localizer
 168   double dist = SGGeodesy::distanceM(mPosition, mRunway->threshold());
 169
 170 // back project that distance along the runway center line
 171   SGGeod newPos = mRunway->pointOnCenterline(dist);
 172
 173   double hdg_diff = get_multiuse() - mRunway->headingDeg();
 174   SG_NORMALIZE_RANGE(hdg_diff, -180.0, 180.0);
 175
 176   if ( fabs(hdg_diff) <= aThreshold ) {
 177     mPosition = SGGeod::fromGeodFt(newPos, mPosition.getElevationFt());
 178     set_multiuse( mRunway->headingDeg() );
 179   } else {
 180     SG_LOG(SG_GENERAL, SG_DEBUG, "localizer:" << ident() << ", aligning with runway "
 181       << mRunway->ident() << " exceeded heading threshold");
 182   }
 183 }
 184
 185 double FGNavRecord::localizerWidth() const
 186 {
 187   if (!mRunway) {
 188     return 6.0;
 189   }
 190
 191   SGVec3d thresholdCart(SGVec3d::fromGeod(mRunway->threshold()));
 192   double axisLength = dist(cart(), thresholdCart);
 193   double landingLength = dist(thresholdCart, SGVec3d::fromGeod(mRunway->end()));
 194
 195 // Reference: http://dcaa.slv.dk:8000/icaodocs/
 196 // ICAO standard width at threshold is 210 m = 689 feet = approx 700 feet.
 197 // ICAO 3.1.1 half course = DDM = 0.0775
 198 // ICAO 3.1.3.7.1 Sensitivity 0.00145 DDM/m at threshold
 199 //  implies peg-to-peg of 214 m ... we will stick with 210.
 200 // ICAO 3.1.3.7.1 "Course sector angle shall not exceed 6 degrees."
 201
 202 // Very short runway:  less than 1200 m (4000 ft) landing length:
 203   if (landingLength < 1200.0) {
 204 // ICAO fudges localizer sensitivity for very short runways.
 205 // This produces a non-monotonic sensitivity-versus length relation.
 206     axisLength += 1050.0;
 207   }
 208
 209 // Example: very short: San Diego   KMYF (Montgomery Field) ILS RWY 28R
 210 // Example: short:      Tom's River KMJX (Robert J. Miller) ILS RWY 6
 211 // Example: very long:  Denver      KDEN (Denver)           ILS RWY 16R
 212   double raw_width = 210.0 / axisLength * SGD_RADIANS_TO_DEGREES;
 213   return raw_width < 6.0? raw_width : 6.0;
 214
 215 }
 216
 217 FGTACANRecord::FGTACANRecord(void) :
 218     channel(""),
 219     freq(0)
 220
 221 {
 222 }
 223
 224 std::istream&
 225 operator >> ( std::istream& in, FGTACANRecord& n )
 226 {
 227     in >> n.channel >> n.freq ;
 228     //getline( in, n.name );
 229
 230     return in;
 231 }