src/Environment/environment_ctrl.cxx

   1 // environment_ctrl.cxx -- manager for natural environment information.
   2 //
   3 // Written by David Megginson, started February 2002.
   4 //
   5 // Copyright (C) 2002  David Megginson - david@megginson.com
   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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23 #include <simgear/debug/logstream.hxx>
  24
  25 #include <stdlib.h>
  26 #include <algorithm>
  27
  28 #include <simgear/structure/commands.hxx>
  29 #include <simgear/structure/exception.hxx>
  30
  31 #include <Airports/simple.hxx>
  32 #include <Main/fg_props.hxx>
  33 #include <Main/util.hxx>
  34
  35 #include "environment_mgr.hxx"
  36 #include "environment_ctrl.hxx"
  37
  38 SG_USING_STD(sort);
  39
  40
  41 \f
  42 ////////////////////////////////////////////////////////////////////////
  43 // Implementation of FGEnvironmentCtrl abstract base class.
  44 ////////////////////////////////////////////////////////////////////////
  45
  46 FGEnvironmentCtrl::FGEnvironmentCtrl ()
  47   : _environment(0),
  48     _lon_deg(0),
  49     _lat_deg(0),
  50     _elev_ft(0)
  51 {
  52 }
  53
  54 FGEnvironmentCtrl::~FGEnvironmentCtrl ()
  55 {
  56 }
  57
  58 void
  59 FGEnvironmentCtrl::setEnvironment (FGEnvironment * environment)
  60 {
  61   _environment = environment;
  62 }
  63
  64 void
  65 FGEnvironmentCtrl::setLongitudeDeg (double lon_deg)
  66 {
  67   _lon_deg = lon_deg;
  68 }
  69
  70 void
  71 FGEnvironmentCtrl::setLatitudeDeg (double lat_deg)
  72 {
  73   _lat_deg = lat_deg;
  74 }
  75
  76 void
  77 FGEnvironmentCtrl::setElevationFt (double elev_ft)
  78 {
  79   _elev_ft = elev_ft;
  80 }
  81
  82 void
  83 FGEnvironmentCtrl::setPosition (double lon_deg, double lat_deg, double elev_ft)
  84 {
  85   _lon_deg = lon_deg;
  86   _lat_deg = lat_deg;
  87   _elev_ft = elev_ft;
  88 }
  89
  90
  91 \f
  92 ////////////////////////////////////////////////////////////////////////
  93 // Implementation of FGUserDefEnvironmentCtrl.
  94 ////////////////////////////////////////////////////////////////////////
  95
  96 FGUserDefEnvironmentCtrl::FGUserDefEnvironmentCtrl ()
  97   : _base_wind_speed_node(0),
  98     _gust_wind_speed_node(0),
  99     _current_wind_speed_kt(0),
 100     _delta_wind_speed_kt(0)
 101 {
 102 }
 103
 104 FGUserDefEnvironmentCtrl::~FGUserDefEnvironmentCtrl ()
 105 {
 106 }
 107
 108 void
 109 FGUserDefEnvironmentCtrl::init ()
 110 {
 111                                 // Fill in some defaults.
 112   if (!fgHasNode("/environment/params/base-wind-speed-kt"))
 113     fgSetDouble("/environment/params/base-wind-speed-kt",
 114                 fgGetDouble("/environment/wind-speed-kt"));
 115   if (!fgHasNode("/environment/params/gust-wind-speed-kt"))
 116     fgSetDouble("/environment/params/gust-wind-speed-kt",
 117                 fgGetDouble("/environment/params/base-wind-speed-kt"));
 118
 119   _base_wind_speed_node =
 120     fgGetNode("/environment/params/base-wind-speed-kt", true);
 121   _gust_wind_speed_node =
 122     fgGetNode("/environment/params/gust-wind-speed-kt", true);
 123
 124   _current_wind_speed_kt = _base_wind_speed_node->getDoubleValue();
 125   _delta_wind_speed_kt = 0.1;
 126 }
 127
 128 void
 129 FGUserDefEnvironmentCtrl::update (double dt)
 130 {
 131   double base_wind_speed = _base_wind_speed_node->getDoubleValue();
 132   double gust_wind_speed = _gust_wind_speed_node->getDoubleValue();
 133
 134   if (gust_wind_speed < base_wind_speed) {
 135       gust_wind_speed = base_wind_speed;
 136       _gust_wind_speed_node->setDoubleValue(gust_wind_speed);
 137   }
 138
 139   if (base_wind_speed == gust_wind_speed) {
 140     _current_wind_speed_kt = base_wind_speed;
 141   } else {
 142     int rn = rand() % 128;
 143     int sign = (_delta_wind_speed_kt < 0 ? -1 : 1);
 144     double gust = _current_wind_speed_kt - base_wind_speed;
 145     double incr = gust / 50;
 146
 147     if (rn == 0)
 148       _delta_wind_speed_kt = - _delta_wind_speed_kt;
 149     else if (rn < 4)
 150       _delta_wind_speed_kt -= incr * sign;
 151     else if (rn < 16)
 152       _delta_wind_speed_kt += incr * sign;
 153
 154     _current_wind_speed_kt += _delta_wind_speed_kt;
 155
 156     if (_current_wind_speed_kt < base_wind_speed) {
 157       _current_wind_speed_kt = base_wind_speed;
 158       _delta_wind_speed_kt = 0.01;
 159     } else if (_current_wind_speed_kt > gust_wind_speed) {
 160       _current_wind_speed_kt = gust_wind_speed;
 161       _delta_wind_speed_kt = -0.01;
 162     }
 163   }
 164
 165   if (_environment != 0)
 166     _environment->set_wind_speed_kt(_current_wind_speed_kt);
 167 }
 168
 169
 170 \f
 171 ////////////////////////////////////////////////////////////////////////
 172 // Implementation of FGInterpolateEnvironmentCtrl.
 173 ////////////////////////////////////////////////////////////////////////
 174
 175 FGInterpolateEnvironmentCtrl::FGInterpolateEnvironmentCtrl ()
 176 {
 177 }
 178
 179 FGInterpolateEnvironmentCtrl::~FGInterpolateEnvironmentCtrl ()
 180 {
 181     unsigned int i;
 182     for (i = 0; i < _boundary_table.size(); i++)
 183         delete _boundary_table[i];
 184     for (i = 0; i < _aloft_table.size(); i++)
 185         delete _aloft_table[i];
 186 }
 187
 188
 189
 190 void
 191 FGInterpolateEnvironmentCtrl::init ()
 192 {
 193     read_table(fgGetNode("/environment/config/boundary", true),
 194                _boundary_table);
 195     read_table(fgGetNode("/environment/config/aloft", true),
 196                _aloft_table);
 197 }
 198
 199 void
 200 FGInterpolateEnvironmentCtrl::reinit ()
 201 {
 202     unsigned int i;
 203     for (i = 0; i < _boundary_table.size(); i++)
 204         delete _boundary_table[i];
 205     for (i = 0; i < _aloft_table.size(); i++)
 206         delete _aloft_table[i];
 207     _boundary_table.clear();
 208     _aloft_table.clear();
 209     init();
 210 }
 211
 212 void
 213 FGInterpolateEnvironmentCtrl::read_table (const SGPropertyNode * node,
 214                                           vector<bucket *> &table)
 215 {
 216     for (int i = 0; i < node->nChildren(); i++) {
 217         const SGPropertyNode * child = node->getChild(i);
 218         if ( strcmp(child->getName(), "entry") == 0
 219              && child->getStringValue("elevation-ft", "")[0] != '\0'
 220              && ( child->getDoubleValue("elevation-ft") > 0.1 || i == 0 ) )
 221         {
 222             bucket * b = new bucket;
 223             if (i > 0)
 224                 b->environment.copy(table[i-1]->environment);
 225             b->environment.read(child);
 226             b->altitude_ft = b->environment.get_elevation_ft();
 227             table.push_back(b);
 228         }
 229     }
 230     sort(table.begin(), table.end());
 231 }
 232
 233 void
 234 FGInterpolateEnvironmentCtrl::update (double delta_time_sec)
 235 {
 236                                 // FIXME
 237     double altitude_ft = fgGetDouble("/position/altitude-ft");
 238     double altitude_agl_ft = fgGetDouble("/position/altitude-agl-ft");
 239     double boundary_transition =
 240         fgGetDouble("/environment/config/boundary-transition-ft", 500);
 241
 242     // double ground_elevation_ft = altitude_ft - altitude_agl_ft;
 243
 244     int length = _boundary_table.size();
 245
 246     if (length > 0) {
 247                                 // boundary table
 248         double boundary_limit = _boundary_table[length-1]->altitude_ft;
 249         if (boundary_limit >= altitude_agl_ft) {
 250             do_interpolate(_boundary_table, altitude_agl_ft,
 251                            _environment);
 252             return;
 253         } else if ((boundary_limit + boundary_transition) >= altitude_agl_ft) {
 254                                 // both tables
 255             do_interpolate(_boundary_table, altitude_agl_ft, &env1);
 256             do_interpolate(_aloft_table, altitude_ft, &env2);
 257             double fraction =
 258                 (altitude_agl_ft - boundary_limit) / boundary_transition;
 259             interpolate(&env1, &env2, fraction, _environment);
 260             return;
 261         }
 262     }
 263
 264                                 // aloft table
 265     do_interpolate(_aloft_table, altitude_ft, _environment);
 266 }
 267
 268 void
 269 FGInterpolateEnvironmentCtrl::do_interpolate (vector<bucket *> &table,
 270                                               double altitude_ft,
 271                                               FGEnvironment * environment)
 272 {
 273     int length = table.size();
 274     if (length == 0)
 275         return;
 276
 277                                 // Boundary conditions
 278     if ((length == 1) || (table[0]->altitude_ft >= altitude_ft)) {
 279         environment->copy(table[0]->environment);
 280         return;
 281     } else if (table[length-1]->altitude_ft <= altitude_ft) {
 282         environment->copy(table[length-1]->environment);
 283         return;
 284     }
 285
 286                                 // Search the interpolation table
 287     for (int i = 0; i < length - 1; i++) {
 288         if ((i == length - 1) || (table[i]->altitude_ft <= altitude_ft)) {
 289                 FGEnvironment * env1 = &(table[i]->environment);
 290                 FGEnvironment * env2 = &(table[i+1]->environment);
 291                 double fraction;
 292                 if (table[i]->altitude_ft == table[i+1]->altitude_ft)
 293                     fraction = 1.0;
 294                 else
 295                     fraction =
 296                         ((altitude_ft - table[i]->altitude_ft) /
 297                          (table[i+1]->altitude_ft - table[i]->altitude_ft));
 298                 interpolate(env1, env2, fraction, environment);
 299
 300                 return;
 301         }
 302     }
 303 }
 304
 305 bool
 306 FGInterpolateEnvironmentCtrl::bucket::operator< (const bucket &b) const
 307 {
 308     return (altitude_ft < b.altitude_ft);
 309 }
 310
 311
 312 \f
 313 ////////////////////////////////////////////////////////////////////////
 314 // Implementation of FGMetarEnvironmentCtrl.
 315 ////////////////////////////////////////////////////////////////////////
 316
 317 FGMetarEnvironmentCtrl::FGMetarEnvironmentCtrl ()
 318     : env( new FGInterpolateEnvironmentCtrl ),
 319       _icao( fgGetString("/sim/presets/airport-id") ),
 320       update_interval_sec( 60.0 ),
 321       elapsed( 60.0 )
 322 {
 323 #ifdef ENABLE_THREADS
 324     thread = new MetarThread(this);
 325     thread->start();
 326 #endif // ENABLE_THREADS
 327 }
 328
 329 FGMetarEnvironmentCtrl::~FGMetarEnvironmentCtrl ()
 330 {
 331 #ifdef ENABLE_THREADS
 332    thread->cancel();
 333    thread->join();
 334 #endif // ENABLE_THREADS
 335
 336    delete env;
 337    env = NULL;
 338 }
 339
 340
 341 // use a "command" to set station temp at station elevation
 342 static void set_temp_at_altitude( float temp_degc, float altitude_ft ) {
 343     SGPropertyNode args;
 344     SGPropertyNode *node = args.getNode("temp-degc", 0, true);
 345     node->setFloatValue( temp_degc );
 346     node = args.getNode("altitude-ft", 0, true);
 347     node->setFloatValue( altitude_ft );
 348     globals->get_commands()->execute("set-outside-air-temp-degc", &args);
 349 }
 350
 351
 352 static void set_dewpoint_at_altitude( float dewpoint_degc, float altitude_ft ) {
 353     SGPropertyNode args;
 354     SGPropertyNode *node = args.getNode("dewpoint-degc", 0, true);
 355     node->setFloatValue( dewpoint_degc );
 356     node = args.getNode("altitude-ft", 0, true);
 357     node->setFloatValue( altitude_ft );
 358     globals->get_commands()->execute("set-dewpoint-temp-degc", &args);
 359 }
 360
 361
 362 void
 363 FGMetarEnvironmentCtrl::update_env_config ()
 364 {
 365     fgSetupWind( fgGetDouble("/environment/metar/base-wind-range-from"),
 366                  fgGetDouble("/environment/metar/base-wind-range-to"),
 367                  fgGetDouble("/environment/metar/base-wind-speed-kt"),
 368                  fgGetDouble("/environment/metar/gust-wind-speed-kt") );
 369
 370     fgDefaultWeatherValue( "visibility-m",
 371                            fgGetDouble("/environment/metar/min-visibility-m") );
 372     set_temp_at_altitude( fgGetDouble("/environment/metar/temperature-degc"),
 373                           station_elevation_ft );
 374     set_dewpoint_at_altitude( fgGetDouble("/environment/metar/dewpoint-degc"),
 375                               station_elevation_ft );
 376     fgDefaultWeatherValue( "pressure-sea-level-inhg",
 377                            fgGetDouble("/environment/metar/pressure-inhg") );
 378 }
 379
 380 void
 381 FGMetarEnvironmentCtrl::init ()
 382 {
 383     const SGPropertyNode *longitude
 384         = fgGetNode( "/position/longitude-deg", true );
 385     const SGPropertyNode *latitude
 386         = fgGetNode( "/position/latitude-deg", true );
 387
 388     bool found_metar = false;
 389     while ( !found_metar ) {
 390         FGAirport a = globals->get_airports()
 391             ->search( longitude->getDoubleValue(),
 392                       latitude->getDoubleValue(),
 393                       true );
 394         if ( fetch_data( a.id ) ) {
 395             cout << "closest station w/ metar = " << a.id << endl;
 396             _icao = a.id;
 397             elapsed = 0.0;
 398             update_env_config();
 399             env->init();
 400             found_metar = true;
 401         } else {
 402             // mark as no metar so it doesn't show up in subsequent
 403             // searches.
 404             cout << "no metar at metar = " << a.id << endl;
 405             globals->get_airports()->no_metar( a.id );
 406         }
 407     }
 408 }
 409
 410 void
 411 FGMetarEnvironmentCtrl::reinit ()
 412 {
 413 #if 0
 414     update_env_config();
 415 #endif
 416
 417     env->reinit();
 418 }
 419
 420 void
 421 FGMetarEnvironmentCtrl::update(double delta_time_sec)
 422 {
 423     static const SGPropertyNode *longitude
 424         = fgGetNode( "/position/longitude-deg", true );
 425     static const SGPropertyNode *latitude
 426         = fgGetNode( "/position/latitude-deg", true );
 427     elapsed += delta_time_sec;
 428     if ( elapsed > update_interval_sec ) {
 429         FGAirport a = globals->get_airports()
 430             ->search( longitude->getDoubleValue(),
 431                       latitude->getDoubleValue(),
 432                       true );
 433         if ( fetch_data( a.id ) ) {
 434             cout << "closest station w/ metar = " << a.id << endl;
 435            _icao = a.id;
 436             elapsed = 0.0;
 437             update_env_config();
 438             env->reinit();
 439         } else {
 440             // mark as no metar so it doesn't show up in subsequent
 441             // searches.
 442             cout << "no metar at metar = " << a.id << endl;
 443             globals->get_airports()->no_metar( a.id );
 444         }
 445     }
 446
 447     env->update(delta_time_sec);
 448 }
 449
 450 void
 451 FGMetarEnvironmentCtrl::setEnvironment (FGEnvironment * environment)
 452 {
 453     env->setEnvironment(environment);
 454 }
 455
 456 bool
 457 FGMetarEnvironmentCtrl::fetch_data (const string &icao)
 458 {
 459     char s[128];
 460     double d, dt;
 461     int i;
 462
 463     if ((icao == "") && (_icao == "")) {
 464         _icao = fgGetString("/sim/presets/airport-id");
 465
 466     } else if (icao != "") {
 467         _icao = icao;
 468     }
 469
 470     // fetch station elevation if exists
 471     FGAirport a = globals->get_airports()->search( _icao );
 472     station_elevation_ft = a.elevation;
 473
 474     // fetch current metar data
 475     SGMetar *m = NULL;
 476 #ifdef ENABLE_THREADS
 477
 478     bool valid_data = false;
 479     if (!metar_queue.empty())
 480     {
 481         m = metar_queue.pop();
 482
 483         if (m != NULL)
 484             valid_data = true;
 485     }
 486
 487     if ( valid_data == false ) {
 488         mutex.lock();
 489         metar_cond.signal();
 490         mutex.unlock();
 491
 492         return false;
 493     }
 494 #else
 495     try {
 496         m = new SGMetar( _icao.c_str() );
 497     } catch (const sg_io_exception& e) {
 498         SG_LOG( SG_GENERAL, SG_WARN, "Error fetching live weather data: "
 499                                       << e.getFormattedMessage().c_str() );
 500         return false;
 501     }
 502 #endif // ENABLE_THREADS
 503
 504     d = m->getMinVisibility().getVisibility_m();
 505     d = (d != SGMetarNaN) ? d : 10000;
 506     fgSetDouble("/environment/metar/min-visibility-m", d);
 507
 508     dt =  m->getMaxVisibility().getVisibility_m();
 509     d = (dt != SGMetarNaN) ? dt : d;
 510     fgSetDouble("/environment/metar/max-visibility-m", d);
 511
 512     SGMetarVisibility *dirvis = m->getDirVisibility();
 513     for (i = 0; i < 8; i++, dirvis++) {
 514         const char *min = "/environment/metar/visibility[%d]/min-m";
 515         const char *max = "/environment/metar/visibility[%d]/max-m";
 516         char s[128];
 517
 518         d = dirvis->getVisibility_m();
 519         d = (d != SGMetarNaN) ? d : 10000;
 520
 521         snprintf(s, 128, min, i);
 522         fgSetDouble(s, d);
 523         snprintf(s, 128, max, i);
 524         fgSetDouble(s, d);
 525     }
 526
 527     i = m->getWindDir();
 528     if ( i == -1 ) {
 529         fgSetInt("/environment/metar/base-wind-range-from",
 530                     m->getWindRangeFrom() );
 531         fgSetInt("/environment/metar/base-wind-range-to",
 532                     m->getWindRangeTo() );
 533     } else {
 534         fgSetInt("/environment/metar/base-wind-range-from", i);
 535         fgSetInt("/environment/metar/base-wind-range-to", i);
 536     }
 537     fgSetDouble("/environment/metar/base-wind-speed-kt",
 538                 m->getWindSpeed_kt() );
 539
 540     d = m->getGustSpeed_kt();
 541     d = (d != SGMetarNaN) ? d : 0.0;
 542     fgSetDouble("/environment/metar/gust-wind-speed-kt", d);
 543
 544     d = m->getTemperature_C();
 545     if (d != SGMetarNaN) {
 546         dt = m->getDewpoint_C();
 547         dt = (dt != SGMetarNaN) ? dt : 0.0;
 548         fgSetDouble("/environment/metar/dewpoint-degc", dt);
 549         fgSetDouble("/environment/metar/rel-humidity-norm",
 550                     m->getRelHumidity() );
 551     }
 552     d = (d != SGMetarNaN) ? d : 15.0;
 553     fgSetDouble("/environment/metar/temperature-degc", d);
 554
 555     d = m->getPressure_inHg();
 556     d = (d != SGMetarNaN) ? d : 30.0;
 557     fgSetDouble("/environment/metar/pressure-inhg", d);
 558
 559     vector<SGMetarCloud> cv = m->getClouds();
 560     vector<SGMetarCloud>::iterator cloud;
 561
 562     const char *cl = "/environment/clouds/layer[%i]";
 563     for (i = 0, cloud = cv.begin(); cloud != cv.end(); cloud++, i++) {
 564         const char *coverage_string[5] =
 565             { "clear", "few", "scattered", "broken", "overcast" };
 566         const double thickness[5] = { 0, 65, 600,750, 1000};
 567         int q;
 568
 569         snprintf(s, 128, cl, i);
 570         strncat(s, "/coverage", 128);
 571         q = cloud->getCoverage();
 572         q = (q != -1 ) ? q : 0;
 573         fgSetString(s, coverage_string[q] );
 574
 575         snprintf(s, 128, cl, i);
 576         strncat(s, "/elevation-ft", 128);
 577         d = cloud->getAltitude_ft();
 578         d = (d != SGMetarNaN) ? d : -9999;
 579         fgSetDouble(s, d + station_elevation_ft);
 580
 581         snprintf(s, 128, cl, i);
 582         strncat(s, "/thickness-ft", 128);
 583         fgSetDouble(s, thickness[q]);
 584
 585         snprintf(s, 128, cl, i);
 586         strncat(s, "/span-m", 128);
 587         fgSetDouble(s, 40000.0);
 588     }
 589     for (; i < FGEnvironmentMgr::MAX_CLOUD_LAYERS; i++) {
 590         snprintf(s, 128, cl, i);
 591         strncat(s, "/coverage", 128);
 592         fgSetString(s, "clear");
 593
 594         snprintf(s, 128, cl, i);
 595         strncat(s, "/elevation-ft", 128);
 596         fgSetDouble(s, -9999);
 597
 598         snprintf(s, 128, cl, i);
 599         strncat(s, "/thickness-ft", 128);
 600         fgSetDouble(s, 0);
 601
 602         snprintf(s, 128, cl, i);
 603         strncat(s, "/span-m", 128);
 604         fgSetDouble(s, 40000.0);
 605     }
 606
 607     delete m;
 608
 609 #ifdef ENABLE_THREADS
 610     mutex.lock();
 611     metar_cond.signal();
 612     mutex.unlock();
 613 #endif // ENABLE_THREADS
 614
 615     return true;
 616 }
 617
 618 #ifdef ENABLE_THREADS
 619 /**
 620  *
 621  */
 622 void
 623 FGMetarEnvironmentCtrl::MetarThread::run()
 624 {
 625     SGMetar *m = NULL;
 626
 627     // pthread_cleanup_push( metar_cleanup_handler, fetcher );
 628     while ( true )
 629     {
 630         set_cancel( SGThread::CANCEL_DISABLE );
 631         try
 632         {
 633             cout << "Fetching ..." << endl;
 634             // if (m != NULL)  m = NULL;
 635             m = new SGMetar( fetcher->_icao.c_str() );
 636
 637         } catch (const sg_io_exception& e) {
 638             // SG_LOG( SG_GENERAL, SG_WARN, "Error fetching live weather data: "
 639             //                             << e.getFormattedMessage().c_str() );
 640             m = NULL;
 641         }
 642         set_cancel( SGThread::CANCEL_DEFERRED );
 643
 644         fetcher->metar_queue.push( m );
 645
 646         // Wait for the next frame signal before we fetch the next metar data
 647         fetcher->mutex.lock();
 648         fetcher->metar_cond.wait( fetcher->mutex );
 649         fetcher->mutex.unlock();
 650     }
 651     // pthread_cleanup_pop(1);
 652 }
 653
 654 /**
 655  * Ensure mutex is unlocked.
 656  */
 657 void
 658 metar_cleanup_handler( void* arg )
 659 {
 660     FGMetarEnvironmentCtrl* fetcher = (FGMetarEnvironmentCtrl*) arg;
 661     fetcher->mutex.unlock();
 662 }
 663 #endif // ENABLE_THREADS
 664
 665
 666 // end of environment_ctrl.cxx