src/Instrumentation/navradio.cxx

   1 // navradio.cxx -- class to manage a nav radio instance
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 //
   5 // Copyright (C) 2000 - 2002  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
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <iostream>
  29 #include <string>
  30 #include <sstream>
  31
  32 #include <simgear/compiler.h>
  33 #include <simgear/sg_inlines.h>
  34 #include <simgear/math/sg_random.h>
  35 #include <simgear/math/vector.hxx>
  36
  37 #include <Aircraft/aircraft.hxx>
  38 #include <Navaids/navlist.hxx>
  39
  40 #include "navradio.hxx"
  41
  42 #include <string>
  43 SG_USING_STD(string);
  44
  45
  46 // Constructor
  47 FGNavRadio::FGNavRadio(SGPropertyNode *node) :
  48     lon_node(fgGetNode("/position/longitude-deg", true)),
  49     lat_node(fgGetNode("/position/latitude-deg", true)),
  50     alt_node(fgGetNode("/position/altitude-ft", true)),
  51     is_valid_node(NULL),
  52     power_btn_node(NULL),
  53     freq_node(NULL),
  54     alt_freq_node(NULL),
  55     sel_radial_node(NULL),
  56     vol_btn_node(NULL),
  57     ident_btn_node(NULL),
  58     audio_btn_node(NULL),
  59     nav_serviceable_node(NULL),
  60     cdi_serviceable_node(NULL),
  61     gs_serviceable_node(NULL),
  62     tofrom_serviceable_node(NULL),
  63     fmt_freq_node(NULL),
  64     fmt_alt_freq_node(NULL),
  65     heading_node(NULL),
  66     radial_node(NULL),
  67     recip_radial_node(NULL),
  68     target_radial_true_node(NULL),
  69     target_auto_hdg_node(NULL),
  70     time_to_intercept(NULL),
  71     to_flag_node(NULL),
  72     from_flag_node(NULL),
  73     inrange_node(NULL),
  74     cdi_deflection_node(NULL),
  75     cdi_xtrack_error_node(NULL),
  76     cdi_xtrack_hdg_err_node(NULL),
  77     has_gs_node(NULL),
  78     loc_node(NULL),
  79     loc_dist_node(NULL),
  80     gs_deflection_node(NULL),
  81     gs_rate_of_climb_node(NULL),
  82     gs_dist_node(NULL),
  83     nav_id_node(NULL),
  84     id_c1_node(NULL),
  85     id_c2_node(NULL),
  86     id_c3_node(NULL),
  87     id_c4_node(NULL),
  88     nav_slaved_to_gps_node(NULL),
  89     gps_cdi_deflection_node(NULL),
  90     gps_to_flag_node(NULL),
  91     gps_from_flag_node(NULL),
  92     last_nav_id(""),
  93     last_nav_vor(false),
  94     play_count(0),
  95     last_time(0),
  96     radial(0.0),
  97     target_radial(0.0),
  98     horiz_vel(0.0),
  99     last_x(0.0),
 100     last_loc_dist(0.0),
 101     last_xtrack_error(0.0),
 102     name("nav"),
 103     num(0),
 104     _time_before_search_sec(-1.0)
 105 {
 106     SGPath path( globals->get_fg_root() );
 107     SGPath term = path;
 108     term.append( "Navaids/range.term" );
 109     SGPath low = path;
 110     low.append( "Navaids/range.low" );
 111     SGPath high = path;
 112     high.append( "Navaids/range.high" );
 113
 114     term_tbl = new SGInterpTable( term.str() );
 115     low_tbl = new SGInterpTable( low.str() );
 116     high_tbl = new SGInterpTable( high.str() );
 117
 118     int i;
 119     for ( i = 0; i < node->nChildren(); ++i ) {
 120         SGPropertyNode *child = node->getChild(i);
 121         string cname = child->getName();
 122         string cval = child->getStringValue();
 123         if ( cname == "name" ) {
 124             name = cval;
 125         } else if ( cname == "number" ) {
 126             num = child->getIntValue();
 127         } else {
 128             SG_LOG( SG_INSTR, SG_WARN,
 129                     "Error in nav radio config logic" );
 130             if ( name.length() ) {
 131                 SG_LOG( SG_INSTR, SG_WARN, "Section = " << name );
 132             }
 133         }
 134     }
 135
 136 }
 137
 138
 139 // Destructor
 140 FGNavRadio::~FGNavRadio()
 141 {
 142     delete term_tbl;
 143     delete low_tbl;
 144     delete high_tbl;
 145 }
 146
 147
 148 void
 149 FGNavRadio::init ()
 150 {
 151     morse.init();
 152
 153     string branch;
 154     branch = "/instrumentation/" + name;
 155
 156     SGPropertyNode *node = fgGetNode(branch.c_str(), num, true );
 157
 158     bus_power_node =
 159         fgGetNode(("/systems/electrical/outputs/" + name).c_str(), true);
 160
 161     // inputs
 162     is_valid_node = node->getChild("data-is-valid", 0, true);
 163     power_btn_node = node->getChild("power-btn", 0, true);
 164     power_btn_node->setBoolValue( true );
 165     vol_btn_node = node->getChild("volume", 0, true);
 166     ident_btn_node = node->getChild("ident", 0, true);
 167     ident_btn_node->setBoolValue( true );
 168     audio_btn_node = node->getChild("audio-btn", 0, true);
 169     audio_btn_node->setBoolValue( true );
 170     nav_serviceable_node = node->getChild("serviceable", 0, true);
 171     cdi_serviceable_node = (node->getChild("cdi", 0, true))
 172         ->getChild("serviceable", 0, true);
 173     gs_serviceable_node = (node->getChild("gs", 0, true))
 174         ->getChild("serviceable");
 175     tofrom_serviceable_node = (node->getChild("to-from", 0, true))
 176         ->getChild("serviceable", 0, true);
 177
 178     // frequencies
 179     SGPropertyNode *subnode = node->getChild("frequencies", 0, true);
 180     freq_node = subnode->getChild("selected-mhz", 0, true);
 181     alt_freq_node = subnode->getChild("standby-mhz", 0, true);
 182     fmt_freq_node = subnode->getChild("selected-mhz-fmt", 0, true);
 183     fmt_alt_freq_node = subnode->getChild("standby-mhz-fmt", 0, true);
 184
 185     // radials
 186     subnode = node->getChild("radials", 0, true);
 187     sel_radial_node = subnode->getChild("selected-deg", 0, true);
 188     radial_node = subnode->getChild("actual-deg", 0, true);
 189     recip_radial_node = subnode->getChild("reciprocal-radial-deg", 0, true);
 190     target_radial_true_node = subnode->getChild("target-radial-deg", 0, true);
 191     target_auto_hdg_node = subnode->getChild("target-auto-hdg-deg", 0, true);
 192
 193     // outputs
 194     heading_node = node->getChild("heading-deg", 0, true);
 195     time_to_intercept = node->getChild("time-to-intercept-sec", 0, true);
 196     to_flag_node = node->getChild("to-flag", 0, true);
 197     from_flag_node = node->getChild("from-flag", 0, true);
 198     inrange_node = node->getChild("in-range", 0, true);
 199     cdi_deflection_node = node->getChild("heading-needle-deflection", 0, true);
 200     cdi_xtrack_error_node = node->getChild("crosstrack-error-m", 0, true);
 201     cdi_xtrack_hdg_err_node
 202         = node->getChild("crosstrack-heading-error-deg", 0, true);
 203     has_gs_node = node->getChild("has-gs", 0, true);
 204     loc_node = node->getChild("nav-loc", 0, true);
 205     loc_dist_node = node->getChild("nav-distance", 0, true);
 206     gs_deflection_node = node->getChild("gs-needle-deflection", 0, true);
 207     gs_rate_of_climb_node = node->getChild("gs-rate-of-climb", 0, true);
 208     gs_dist_node = node->getChild("gs-distance", 0, true);
 209     nav_id_node = node->getChild("nav-id", 0, true);
 210     id_c1_node = node->getChild("nav-id_asc1", 0, true);
 211     id_c2_node = node->getChild("nav-id_asc2", 0, true);
 212     id_c3_node = node->getChild("nav-id_asc3", 0, true);
 213     id_c4_node = node->getChild("nav-id_asc4", 0, true);
 214
 215     // gps slaving support
 216     nav_slaved_to_gps_node = node->getChild("slaved-to-gps", 0, true);
 217     gps_cdi_deflection_node = fgGetNode("/instrumentation/gps/cdi-deflection", true);
 218     gps_to_flag_node = fgGetNode("/instrumentation/gps/to-flag", true);
 219     gps_from_flag_node = fgGetNode("/instrumentation/gps/from-flag", true);
 220
 221     std::ostringstream temp;
 222     temp << name << "nav-ident" << num;
 223     nav_fx_name = temp.str();
 224     temp << name << "dme-ident" << num;
 225     dme_fx_name = temp.str();
 226 }
 227
 228 void
 229 FGNavRadio::bind ()
 230 {
 231     std::ostringstream temp;
 232     string branch;
 233     temp << num;
 234     branch = "/instrumentation/" + name + "[" + temp.str() + "]";
 235 }
 236
 237
 238 void
 239 FGNavRadio::unbind ()
 240 {
 241     std::ostringstream temp;
 242     string branch;
 243     temp << num;
 244     branch = "/instrumentation/" + name + "[" + temp.str() + "]";
 245 }
 246
 247
 248 // model standard VOR/DME/TACAN service volumes as per AIM 1-1-8
 249 double FGNavRadio::adjustNavRange( double stationElev, double aircraftElev,
 250                                  double nominalRange )
 251 {
 252     // extend out actual usable range to be 1.3x the published safe range
 253     const double usability_factor = 1.3;
 254
 255     // assumptions we model the standard service volume, plus
 256     // ... rather than specifying a cylinder, we model a cone that
 257     // contains the cylinder.  Then we put an upside down cone on top
 258     // to model diminishing returns at too-high altitudes.
 259
 260     // altitude difference
 261     double alt = ( aircraftElev * SG_METER_TO_FEET - stationElev );
 262     // cout << "aircraft elev = " << aircraftElev * SG_METER_TO_FEET
 263     //      << " station elev = " << stationElev << endl;
 264
 265     if ( nominalRange < 25.0 + SG_EPSILON ) {
 266         // Standard Terminal Service Volume
 267         return term_tbl->interpolate( alt ) * usability_factor;
 268     } else if ( nominalRange < 50.0 + SG_EPSILON ) {
 269         // Standard Low Altitude Service Volume
 270         // table is based on range of 40, scale to actual range
 271         return low_tbl->interpolate( alt ) * nominalRange / 40.0
 272             * usability_factor;
 273     } else {
 274         // Standard High Altitude Service Volume
 275         // table is based on range of 130, scale to actual range
 276         return high_tbl->interpolate( alt ) * nominalRange / 130.0
 277             * usability_factor;
 278     }
 279 }
 280
 281
 282 // model standard ILS service volumes as per AIM 1-1-9
 283 double FGNavRadio::adjustILSRange( double stationElev, double aircraftElev,
 284                                  double offsetDegrees, double distance )
 285 {
 286     // assumptions we model the standard service volume, plus
 287
 288     // altitude difference
 289     // double alt = ( aircraftElev * SG_METER_TO_FEET - stationElev );
 290 //     double offset = fabs( offsetDegrees );
 291
 292 //     if ( offset < 10 ) {
 293 //      return FG_ILS_DEFAULT_RANGE;
 294 //     } else if ( offset < 35 ) {
 295 //      return 10 + (35 - offset) * (FG_ILS_DEFAULT_RANGE - 10) / 25;
 296 //     } else if ( offset < 45 ) {
 297 //      return (45 - offset);
 298 //     } else if ( offset > 170 ) {
 299 //         return FG_ILS_DEFAULT_RANGE;
 300 //     } else if ( offset > 145 ) {
 301 //      return 10 + (offset - 145) * (FG_ILS_DEFAULT_RANGE - 10) / 25;
 302 //     } else if ( offset > 135 ) {
 303 //         return (offset - 135);
 304 //     } else {
 305 //      return 0;
 306 //     }
 307     return FG_LOC_DEFAULT_RANGE;
 308 }
 309
 310
 311 //////////////////////////////////////////////////////////////////////////
 312 // Update the various nav values based on position and valid tuned in navs
 313 //////////////////////////////////////////////////////////////////////////
 314 void
 315 FGNavRadio::update(double dt)
 316 {
 317     // Do a nav station search only once a second to reduce
 318     // unnecessary work. (Also, make sure to do this before caching
 319     // any values!)
 320     _time_before_search_sec -= dt;
 321     if ( _time_before_search_sec < 0 ) {
 322         search();
 323     }
 324
 325     // cache a few strategic values locally for speed
 326     SGGeod pos = SGGeod::fromDegFt(lon_node->getDoubleValue(),
 327                                    lat_node->getDoubleValue(),
 328                                    alt_node->getDoubleValue());
 329     bool power_btn = power_btn_node->getBoolValue();
 330     bool nav_serviceable = nav_serviceable_node->getBoolValue();
 331     bool cdi_serviceable = cdi_serviceable_node->getBoolValue();
 332     bool tofrom_serviceable = tofrom_serviceable_node->getBoolValue();
 333     bool inrange = inrange_node->getBoolValue();
 334     bool has_gs = has_gs_node->getBoolValue();
 335     bool is_loc = loc_node->getBoolValue();
 336     double loc_dist = loc_dist_node->getDoubleValue();
 337
 338     double az1, az2, s;
 339
 340     // Create "formatted" versions of the nav frequencies for
 341     // instrument displays.
 342     char tmp[16];
 343     sprintf( tmp, "%.2f", freq_node->getDoubleValue() );
 344     fmt_freq_node->setStringValue(tmp);
 345     sprintf( tmp, "%.2f", alt_freq_node->getDoubleValue() );
 346     fmt_alt_freq_node->setStringValue(tmp);
 347
 348     // cout << "is_valid = " << is_valid
 349     //      << " power_btn = " << power_btn
 350     //      << " bus_power = " << bus_power_node->getDoubleValue()
 351     //      << " nav_serviceable = " << nav_serviceable
 352     //      << endl;
 353
 354     if ( is_valid && power_btn && (bus_power_node->getDoubleValue() > 1.0)
 355          && nav_serviceable )
 356     {
 357         SGVec3d aircraft = SGVec3d::fromGeod(pos);
 358         loc_dist = dist(aircraft, nav_xyz);
 359         loc_dist_node->setDoubleValue( loc_dist );
 360         // cout << "dt = " << dt << " dist = " << loc_dist << endl;
 361
 362         if ( has_gs ) {
 363             // find closest distance to the gs base line
 364             SGVec3d p = aircraft;
 365             double dist = sgdClosestPointToLineDistSquared(p.sg(), gs_xyz.sg(),
 366                                                            gs_base_vec.sg());
 367             gs_dist_node->setDoubleValue( sqrt( dist ) );
 368             // cout << "gs_dist = " << gs_dist_node->getDoubleValue()
 369             //      << endl;
 370
 371             // wgs84 heading to glide slope (to determine sign of distance)
 372             geo_inverse_wgs_84( pos, SGGeod::fromDeg(gs_lon, gs_lat),
 373                                 &az1, &az2, &s );
 374             double r = az1 - target_radial;
 375             while ( r >  180.0 ) { r -= 360.0;}
 376             while ( r < -180.0 ) { r += 360.0;}
 377             if ( r >= -90.0 && r <= 90.0 ) {
 378                 gs_dist_signed = gs_dist_node->getDoubleValue();
 379             } else {
 380                 gs_dist_signed = -gs_dist_node->getDoubleValue();
 381             }
 382             /* cout << "Target Radial = " << target_radial
 383                  << "  Bearing = " << az1
 384                  << "  dist (signed) = " << gs_dist_signed
 385                  << endl; */
 386
 387         } else {
 388             gs_dist_node->setDoubleValue( 0.0 );
 389         }
 390
 391         //////////////////////////////////////////////////////////
 392         // compute forward and reverse wgs84 headings to localizer
 393         //////////////////////////////////////////////////////////
 394         double hdg;
 395         geo_inverse_wgs_84( pos, SGGeod::fromDeg(loc_lon, loc_lat),
 396                             &hdg, &az2, &s );
 397         // cout << "az1 = " << az1 << " magvar = " << nav_magvar << endl;
 398         heading_node->setDoubleValue( hdg );
 399         radial = az2 - twist;
 400         double recip = radial + 180.0;
 401         if ( recip >= 360.0 ) { recip -= 360.0; }
 402         radial_node->setDoubleValue( radial );
 403         recip_radial_node->setDoubleValue( recip );
 404         // cout << " heading = " << heading_node->getDoubleValue()
 405         //      << " dist = " << nav_dist << endl;
 406
 407         //////////////////////////////////////////////////////////
 408         // compute the target/selected radial in "true" heading
 409         //////////////////////////////////////////////////////////
 410         double trtrue = 0.0;
 411         if ( is_loc ) {
 412             // ILS localizers radials are already "true" in our
 413             // database
 414             trtrue = target_radial;
 415         } else {
 416             // VOR radials need to have that vor's offset added in
 417             trtrue = target_radial + twist;
 418         }
 419
 420         while ( trtrue < 0.0 ) { trtrue += 360.0; }
 421         while ( trtrue > 360.0 ) { trtrue -= 360.0; }
 422         target_radial_true_node->setDoubleValue( trtrue );
 423
 424         //////////////////////////////////////////////////////////
 425         // adjust reception range for altitude
 426         // FIXME: make sure we are using the navdata range now that
 427         //        it is valid in the data file
 428         //////////////////////////////////////////////////////////
 429         if ( is_loc ) {
 430             double offset = radial - target_radial;
 431             while ( offset < -180.0 ) { offset += 360.0; }
 432             while ( offset > 180.0 ) { offset -= 360.0; }
 433             // cout << "ils offset = " << offset << endl;
 434             effective_range
 435                 = adjustILSRange( nav_elev, pos.getElevationM(), offset,
 436                                   loc_dist * SG_METER_TO_NM );
 437         } else {
 438             effective_range
 439                 = adjustNavRange( nav_elev, pos.getElevationM(), range );
 440         }
 441         // cout << "nav range = " << effective_range
 442         //      << " (" << range << ")" << endl;
 443
 444         if ( loc_dist < effective_range * SG_NM_TO_METER ) {
 445             inrange = true;
 446         } else if ( loc_dist < 2 * effective_range * SG_NM_TO_METER ) {
 447             inrange = sg_random() < ( 2 * effective_range * SG_NM_TO_METER
 448                                       - loc_dist )
 449                                       / (effective_range * SG_NM_TO_METER);
 450         } else {
 451             inrange = false;
 452         }
 453         inrange_node->setBoolValue( inrange );
 454
 455         if ( !is_loc ) {
 456             target_radial = sel_radial_node->getDoubleValue();
 457         }
 458
 459         //////////////////////////////////////////////////////////
 460         // compute to/from flag status
 461         //////////////////////////////////////////////////////////
 462         double value = false;
 463         double offset = fabs(radial - target_radial);
 464         if ( tofrom_serviceable ) {
 465             if ( nav_slaved_to_gps_node->getBoolValue() ) {
 466                 value = gps_to_flag_node->getBoolValue();
 467             } else if ( inrange ) {
 468                 if ( is_loc ) {
 469                     value = true;
 470                 } else {
 471                     value = !(offset <= 90.0 || offset >= 270.0);
 472                 }
 473             }
 474         } else {
 475             value = false;
 476         }
 477         to_flag_node->setBoolValue( value );
 478
 479         value = false;
 480         if ( tofrom_serviceable ) {
 481             if ( nav_slaved_to_gps_node->getBoolValue() ) {
 482                 value = gps_from_flag_node->getBoolValue();
 483             } else if ( inrange ) {
 484                 if ( is_loc ) {
 485                     value = false;
 486                 } else {
 487                     value = !(offset > 90.0 && offset < 270.0);
 488                 }
 489             }
 490         } else {
 491             value = false;
 492         }
 493         from_flag_node->setBoolValue( value );
 494
 495         //////////////////////////////////////////////////////////
 496         // compute the deflection of the CDI needle, clamped to the range
 497         // of ( -10 , 10 )
 498         //////////////////////////////////////////////////////////
 499         double r = 0.0;
 500         bool loc_bc = false;   // an in-code flag indicating that we are
 501                                // on a localizer backcourse.
 502         if ( cdi_serviceable ) {
 503             if ( nav_slaved_to_gps_node->getBoolValue() ) {
 504                 r = gps_cdi_deflection_node->getDoubleValue();
 505                 // We want +- 5 dots deflection for the gps, so clamp
 506                 // to -12.5/12.5
 507                 SG_CLAMP_RANGE( r, -12.5, 12.5 );
 508             } else if ( inrange ) {
 509                 r = radial - target_radial;
 510                 // cout << "Target radial = " << target_radial
 511                 //      << "  Actual radial = " << radial << endl;
 512
 513                 while ( r >  180.0 ) { r -= 360.0;}
 514                 while ( r < -180.0 ) { r += 360.0;}
 515                 if ( fabs(r) > 90.0 ) {
 516                     r = ( r<0.0 ? -r-180.0 : -r+180.0 );
 517                 } else {
 518                     if ( is_loc ) {
 519                         loc_bc = true;
 520                     }
 521                 }
 522
 523                 r = -r;         // reverse, since radial is outbound
 524                 if ( is_loc ) {
 525                     // According to Robin Peel, the ILS is 4x more
 526                     // sensitive than a vor
 527                     r *= 4.0;
 528                 }
 529                 SG_CLAMP_RANGE( r, -10.0, 10.0 );
 530             }
 531         }
 532         cdi_deflection_node->setDoubleValue( r );
 533
 534         //////////////////////////////////////////////////////////
 535         // compute the amount of cross track distance error in meters
 536         //////////////////////////////////////////////////////////
 537         double xtrack_error = 0.0;
 538         if ( inrange && nav_serviceable && cdi_serviceable ) {
 539             r = radial - target_radial;
 540             // cout << "Target radial = " << target_radial
 541             //     << "  Actual radial = " << radial
 542             //     << "  r = " << r << endl;
 543
 544             while ( r >  180.0 ) { r -= 360.0;}
 545             while ( r < -180.0 ) { r += 360.0;}
 546             if ( fabs(r) > 90.0 ) {
 547                 r = ( r<0.0 ? -r-180.0 : -r+180.0 );
 548             }
 549
 550             r = -r;             // reverse, since radial is outbound
 551
 552             xtrack_error = loc_dist * sin(r * SGD_DEGREES_TO_RADIANS);
 553         } else {
 554             xtrack_error = 0.0;
 555         }
 556         cdi_xtrack_error_node->setDoubleValue( xtrack_error );
 557
 558         //////////////////////////////////////////////////////////
 559         // compute an approximate ground track heading error
 560         //////////////////////////////////////////////////////////
 561         double hdg_error = 0.0;
 562         if ( inrange && cdi_serviceable ) {
 563             double vn = fgGetDouble( "/velocities/speed-north-fps" );
 564             double ve = fgGetDouble( "/velocities/speed-east-fps" );
 565             double gnd_trk_true = atan2( ve, vn ) * SGD_RADIANS_TO_DEGREES;
 566             if ( gnd_trk_true < 0.0 ) { gnd_trk_true += 360.0; }
 567
 568             SGPropertyNode *true_hdg
 569                 = fgGetNode("/orientation/heading-deg", true);
 570             hdg_error = gnd_trk_true - true_hdg->getDoubleValue();
 571
 572             // cout << "ground track = " << gnd_trk_true
 573             //      << " orientation = " << true_hdg->getDoubleValue() << endl;
 574         }
 575         cdi_xtrack_hdg_err_node->setDoubleValue( hdg_error );
 576
 577         //////////////////////////////////////////////////////////
 578         // compute the time to intercept selected radial (based on
 579         // current and last cross track errors and dt
 580         //////////////////////////////////////////////////////////
 581         double t = 0.0;
 582         if ( inrange && cdi_serviceable ) {
 583             double xrate_ms = (last_xtrack_error - xtrack_error) / dt;
 584             if ( fabs(xrate_ms) > 0.00001 ) {
 585                 t = xtrack_error / xrate_ms;
 586             } else {
 587                 t = 9999.9;
 588             }
 589         }
 590         time_to_intercept->setDoubleValue( t );
 591
 592         //////////////////////////////////////////////////////////
 593         // compute the amount of glide slope needle deflection
 594         // (.i.e. the number of degrees we are off the glide slope * 5.0
 595         //
 596         // CLO - 13 Mar 2006: The glide slope needle should peg at
 597         // +/-0.7 degrees off the ideal glideslope.  I'm not sure why
 598         // we compute the factor the way we do (5*gs_error), but we
 599         // need to compensate for our 'odd' number in the glideslope
 600         // needle animation.  This means that the needle should peg
 601         // when this values is +/-3.5.
 602         //////////////////////////////////////////////////////////
 603         r = 0.0;
 604         if ( has_gs && gs_serviceable_node->getBoolValue() ) {
 605             if ( nav_slaved_to_gps_node->getBoolValue() ) {
 606                 // FIXME/FINISHME, what should be set here?
 607             } else if ( inrange ) {
 608                 double x = gs_dist_node->getDoubleValue();
 609                 double y = (fgGetDouble("/position/altitude-ft") - nav_elev)
 610                     * SG_FEET_TO_METER;
 611                 // cout << "dist = " << x << " height = " << y << endl;
 612                 double angle = asin( y / x ) * SGD_RADIANS_TO_DEGREES;
 613                 r = (target_gs - angle) * 5.0;
 614             }
 615         }
 616         gs_deflection_node->setDoubleValue( r );
 617
 618         //////////////////////////////////////////////////////////
 619         // Calculate desired rate of climb for intercepting the GS
 620         //////////////////////////////////////////////////////////
 621         double x = gs_dist_node->getDoubleValue();
 622         double y = (alt_node->getDoubleValue() - nav_elev)
 623             * SG_FEET_TO_METER;
 624         double current_angle = atan2( y, x ) * SGD_RADIANS_TO_DEGREES;
 625
 626         double target_angle = target_gs;
 627         double gs_diff = target_angle - current_angle;
 628
 629         // convert desired vertical path angle into a climb rate
 630         double des_angle = current_angle - 10 * gs_diff;
 631
 632         // estimate horizontal speed towards ILS in meters per minute
 633         double dist = last_x - x;
 634         last_x = x;
 635         if ( dt > 0.0 ) {
 636             // avoid nan
 637             double new_vel = ( dist / dt );
 638
 639             horiz_vel = 0.75 * horiz_vel + 0.25 * new_vel;
 640             // double horiz_vel = cur_fdm_state->get_V_ground_speed()
 641             //    * SG_FEET_TO_METER * 60.0;
 642             // double horiz_vel = airspeed_node->getFloatValue()
 643             //    * SG_FEET_TO_METER * 60.0;
 644
 645             gs_rate_of_climb_node
 646                 ->setDoubleValue( -sin( des_angle * SGD_DEGREES_TO_RADIANS )
 647                                   * horiz_vel * SG_METER_TO_FEET );
 648         }
 649
 650         //////////////////////////////////////////////////////////
 651         // Calculate a suggested target heading to smoothly intercept
 652         // a nav/ils radial.
 653         //////////////////////////////////////////////////////////
 654
 655         // Now that we have cross track heading adjustment built in,
 656         // we shouldn't need to overdrive the heading angle within 8km
 657         // of the station.
 658         //
 659         // The cdi deflection should be +/-10 for a full range of deflection
 660         // so multiplying this by 3 gives us +/- 30 degrees heading
 661         // compensation.
 662         double adjustment = cdi_deflection_node->getDoubleValue() * 3.0;
 663         SG_CLAMP_RANGE( adjustment, -30.0, 30.0 );
 664
 665         // determine the target heading to fly to intercept the
 666         // tgt_radial = target radial (true) + cdi offset adjustmest -
 667         // xtrack heading error adjustment
 668         double nta_hdg = 0.0;
 669         if ( is_loc && loc_bc ) {
 670             // tuned to a localizer and positioned in backcourse range
 671             // trtrue += 180.0;   // reverse the target localizer heading
 672             // while ( trtrue > 360.0 ) { trtrue -= 360.0; }
 673             nta_hdg = trtrue + adjustment - hdg_error;
 674             cout << "trtrue = " << trtrue << " adj = " << adjustment
 675                  << " hdg_error = " << hdg_error << endl;
 676        } else {
 677             // all other situations (nav or loc front course)
 678             nta_hdg = trtrue + adjustment - hdg_error;
 679         }
 680
 681         while ( nta_hdg <   0.0 ) { nta_hdg += 360.0; }
 682         while ( nta_hdg >= 360.0 ) { nta_hdg -= 360.0; }
 683         target_auto_hdg_node->setDoubleValue( nta_hdg );
 684
 685         last_xtrack_error = xtrack_error;
 686    } else {
 687         inrange_node->setBoolValue( false );
 688         cdi_deflection_node->setDoubleValue( 0.0 );
 689         cdi_xtrack_error_node->setDoubleValue( 0.0 );
 690         cdi_xtrack_hdg_err_node->setDoubleValue( 0.0 );
 691         time_to_intercept->setDoubleValue( 0.0 );
 692         gs_deflection_node->setDoubleValue( 0.0 );
 693         to_flag_node->setBoolValue( false );
 694         from_flag_node->setBoolValue( false );
 695         // cout << "not picking up vor. :-(" << endl;
 696     }
 697
 698     // audio effects
 699     if ( is_valid && inrange && nav_serviceable ) {
 700         // play station ident via audio system if on + ident,
 701         // otherwise turn it off
 702         if ( power_btn
 703              && (bus_power_node->getDoubleValue() > 1.0)
 704              && ident_btn_node->getBoolValue()
 705              && audio_btn_node->getBoolValue() )
 706         {
 707             SGSoundSample *sound;
 708             sound = globals->get_soundmgr()->find( nav_fx_name );
 709             double vol = vol_btn_node->getDoubleValue();
 710             if ( vol < 0.0 ) { vol = 0.0; }
 711             if ( vol > 1.0 ) { vol = 1.0; }
 712             if ( sound != NULL ) {
 713                 sound->set_volume( vol );
 714             } else {
 715                 SG_LOG( SG_COCKPIT, SG_ALERT,
 716                         "Can't find nav-vor-ident sound" );
 717             }
 718             sound = globals->get_soundmgr()->find( dme_fx_name );
 719             if ( sound != NULL ) {
 720                 sound->set_volume( vol );
 721             } else {
 722                 SG_LOG( SG_COCKPIT, SG_ALERT,
 723                         "Can't find nav-dme-ident sound" );
 724             }
 725             // cout << "last_time = " << last_time << " ";
 726             // cout << "cur_time = "
 727             //      << globals->get_time_params()->get_cur_time();
 728             if ( last_time <
 729                  globals->get_time_params()->get_cur_time() - 30 ) {
 730                 last_time = globals->get_time_params()->get_cur_time();
 731                 play_count = 0;
 732             }
 733             // cout << " play_count = " << play_count << endl;
 734             // cout << "playing = "
 735             //      << globals->get_soundmgr()->is_playing(nav_fx_name)
 736             //      << endl;
 737             if ( play_count < 4 ) {
 738                 // play VOR ident
 739                 if ( !globals->get_soundmgr()->is_playing(nav_fx_name) ) {
 740                     globals->get_soundmgr()->play_once( nav_fx_name );
 741                     ++play_count;
 742                 }
 743             } else if ( play_count < 5 && has_dme ) {
 744                 // play DME ident
 745                 if ( !globals->get_soundmgr()->is_playing(nav_fx_name) &&
 746                      !globals->get_soundmgr()->is_playing(dme_fx_name) ) {
 747                     globals->get_soundmgr()->play_once( dme_fx_name );
 748                     ++play_count;
 749                 }
 750             }
 751         } else {
 752             globals->get_soundmgr()->stop( nav_fx_name );
 753             globals->get_soundmgr()->stop( dme_fx_name );
 754         }
 755     }
 756
 757     last_loc_dist = loc_dist;
 758 }
 759
 760
 761 // Update current nav/adf radio stations based on current postition
 762 void FGNavRadio::search()
 763 {
 764
 765     // reset search time
 766     _time_before_search_sec = 1.0;
 767
 768     // cache values locally for speed
 769     double lon = lon_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 770     double lat = lat_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 771     double elev = alt_node->getDoubleValue() * SG_FEET_TO_METER;
 772
 773     FGNavRecord *nav = NULL;
 774     FGNavRecord *loc = NULL;
 775     FGNavRecord *dme = NULL;
 776     FGNavRecord *gs = NULL;
 777
 778     ////////////////////////////////////////////////////////////////////////
 779     // Nav.
 780     ////////////////////////////////////////////////////////////////////////
 781
 782     double freq = freq_node->getDoubleValue();
 783     nav = globals->get_navlist()->findByFreq(freq, lon, lat, elev);
 784     dme = globals->get_dmelist()->findByFreq(freq, lon, lat, elev);
 785     if ( nav == NULL ) {
 786         loc = globals->get_loclist()->findByFreq(freq, lon, lat, elev);
 787         gs = globals->get_gslist()->findByFreq(freq, lon, lat, elev);
 788     }
 789
 790     string nav_id = "";
 791
 792     if ( loc != NULL ) {
 793         nav_id = loc->get_ident();
 794         nav_id_node->setStringValue( nav_id.c_str() );
 795         // cout << "localizer = " << nav_id_node->getStringValue() << endl;
 796         is_valid = true;
 797         if ( last_nav_id != nav_id || last_nav_vor ) {
 798             trans_ident = loc->get_trans_ident();
 799             target_radial = loc->get_multiuse();
 800             while ( target_radial <   0.0 ) { target_radial += 360.0; }
 801             while ( target_radial > 360.0 ) { target_radial -= 360.0; }
 802             loc_lon = loc->get_lon();
 803             loc_lat = loc->get_lat();
 804             nav_xyz = loc->get_cart();
 805             last_nav_id = nav_id;
 806             last_nav_vor = false;
 807             loc_node->setBoolValue( true );
 808             has_dme = (dme != NULL);
 809             if ( gs != NULL ) {
 810                 has_gs_node->setBoolValue( true );
 811                 gs_lon = gs->get_lon();
 812                 gs_lat = gs->get_lat();
 813                 nav_elev = gs->get_elev_ft();
 814                 int tmp = (int)(gs->get_multiuse() / 1000.0);
 815                 target_gs = (double)tmp / 100.0;
 816                 gs_xyz = gs->get_cart();
 817
 818                 // derive GS baseline (perpendicular to the runay
 819                 // along the ground)
 820                 double tlon, tlat, taz;
 821                 geo_direct_wgs_84 ( 0.0, gs_lat, gs_lon,
 822                                     target_radial + 90,
 823                                     100.0, &tlat, &tlon, &taz );
 824                 // cout << "target_radial = " << target_radial << endl;
 825                 // cout << "nav_loc = " << loc_node->getBoolValue() << endl;
 826                 // cout << gs_lon << "," << gs_lat << "  "
 827                 //      << tlon << "," << tlat << "  (" << nav_elev << ")"
 828                 //      << endl;
 829                 SGGeod tpos = SGGeod::fromDegFt(tlon, tlat, nav_elev);
 830                 SGVec3d p1 = SGVec3d::fromGeod(tpos);
 831
 832                 // cout << gs_xyz << endl;
 833                 // cout << p1 << endl;
 834                 gs_base_vec = p1 - gs_xyz;
 835                 // cout << gs_base_vec << endl;
 836             } else {
 837                 has_gs_node->setBoolValue( false );
 838                 nav_elev = loc->get_elev_ft();
 839             }
 840             twist = 0;
 841             range = FG_LOC_DEFAULT_RANGE;
 842             effective_range = range;
 843
 844             if ( globals->get_soundmgr()->exists( nav_fx_name ) ) {
 845                 globals->get_soundmgr()->remove( nav_fx_name );
 846             }
 847             SGSoundSample *sound;
 848             sound = morse.make_ident( trans_ident, LO_FREQUENCY );
 849             sound->set_volume( 0.3 );
 850             globals->get_soundmgr()->add( sound, nav_fx_name );
 851
 852             if ( globals->get_soundmgr()->exists( dme_fx_name ) ) {
 853                 globals->get_soundmgr()->remove( dme_fx_name );
 854             }
 855             sound = morse.make_ident( trans_ident, HI_FREQUENCY );
 856             sound->set_volume( 0.3 );
 857             globals->get_soundmgr()->add( sound, dme_fx_name );
 858
 859             int offset = (int)(sg_random() * 30.0);
 860             play_count = offset / 4;
 861             last_time = globals->get_time_params()->get_cur_time() -
 862                 offset;
 863             // cout << "offset = " << offset << " play_count = "
 864             //      << play_count
 865             //      << " last_time = " << last_time
 866             //      << " current time = "
 867             //      << globals->get_time_params()->get_cur_time() << endl;
 868
 869             // cout << "Found an loc station in range" << endl;
 870             // cout << " id = " << loc->get_locident() << endl;
 871         }
 872     } else if ( nav != NULL ) {
 873         nav_id = nav->get_ident();
 874         nav_id_node->setStringValue( nav_id.c_str() );
 875         // cout << "nav = " << nav_id << endl;
 876         is_valid = true;
 877         if ( last_nav_id != nav_id || !last_nav_vor ) {
 878             last_nav_id = nav_id;
 879             last_nav_vor = true;
 880             trans_ident = nav->get_trans_ident();
 881             loc_node->setBoolValue( false );
 882             has_dme = (dme != NULL);
 883             has_gs_node->setBoolValue( false );
 884             loc_lon = nav->get_lon();
 885             loc_lat = nav->get_lat();
 886             nav_elev = nav->get_elev_ft();
 887             twist = nav->get_multiuse();
 888             range = nav->get_range();
 889             effective_range = adjustNavRange(nav_elev, elev, range);
 890             target_gs = 0.0;
 891             target_radial = sel_radial_node->getDoubleValue();
 892             nav_xyz = nav->get_cart();
 893
 894             if ( globals->get_soundmgr()->exists( nav_fx_name ) ) {
 895                 globals->get_soundmgr()->remove( nav_fx_name );
 896             }
 897             try {
 898                 SGSoundSample *sound;
 899                 sound = morse.make_ident( trans_ident, LO_FREQUENCY );
 900                 sound->set_volume( 0.3 );
 901                 if ( globals->get_soundmgr()->add( sound, nav_fx_name ) ) {
 902                     // cout << "Added nav-vor-ident sound" << endl;
 903                 } else {
 904                     SG_LOG(SG_COCKPIT, SG_WARN, "Failed to add v1-vor-ident sound");
 905                 }
 906
 907                 if ( globals->get_soundmgr()->exists( dme_fx_name ) ) {
 908                     globals->get_soundmgr()->remove( dme_fx_name );
 909                 }
 910                 sound = morse.make_ident( trans_ident, HI_FREQUENCY );
 911                 sound->set_volume( 0.3 );
 912                 globals->get_soundmgr()->add( sound, dme_fx_name );
 913
 914                 int offset = (int)(sg_random() * 30.0);
 915                 play_count = offset / 4;
 916                 last_time = globals->get_time_params()->get_cur_time() - offset;
 917                 // cout << "offset = " << offset << " play_count = "
 918                 //      << play_count << " last_time = "
 919                 //      << last_time << " current time = "
 920                 //      << globals->get_time_params()->get_cur_time() << endl;
 921
 922                 // cout << "Found a vor station in range" << endl;
 923                 // cout << " id = " << nav->get_ident() << endl;
 924             } catch ( sg_io_exception &e ) {
 925                 SG_LOG(SG_GENERAL, SG_ALERT, e.getFormattedMessage());
 926             }
 927         }
 928     } else {
 929         is_valid = false;
 930         nav_id_node->setStringValue( "" );
 931         target_radial = 0;
 932         trans_ident = "";
 933         last_nav_id = "";
 934         if ( ! globals->get_soundmgr()->remove( nav_fx_name ) ) {
 935             SG_LOG(SG_COCKPIT, SG_WARN, "Failed to remove nav-vor-ident sound");
 936         }
 937         globals->get_soundmgr()->remove( dme_fx_name );
 938         // cout << "not picking up vor1. :-(" << endl;
 939     }
 940
 941     is_valid_node->setBoolValue( is_valid );
 942
 943     char tmpid[5];
 944     strncpy( tmpid, nav_id.c_str(), 5 );
 945     id_c1_node->setIntValue( (int)tmpid[0] );
 946     id_c2_node->setIntValue( (int)tmpid[1] );
 947     id_c3_node->setIntValue( (int)tmpid[2] );
 948     id_c4_node->setIntValue( (int)tmpid[3] );
 949 }