src/Environment/environment_mgr.cxx

   1 // environment-mgr.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 #include <simgear/scene/sky/sky.hxx>
  25
  26 #include <Main/main.hxx>
  27 #include <Main/fg_props.hxx>
  28 #include <Aircraft/aircraft.hxx>
  29
  30 #include "environment.hxx"
  31 #include "environment_ctrl.hxx"
  32 #include "environment_mgr.hxx"
  33
  34
  35 FGEnvironmentMgr::FGEnvironmentMgr ()
  36   : _environment(new FGEnvironment)
  37 {
  38
  39    if (fgGetBool("/environment/params/real-world-weather-fetch") == true)
  40        _controller = new FGMetarEnvironmentCtrl;
  41    else
  42        _controller = new FGInterpolateEnvironmentCtrl;
  43
  44   _controller->setEnvironment(_environment);
  45   set_subsystem("controller", _controller, 0.5);
  46 }
  47
  48 FGEnvironmentMgr::~FGEnvironmentMgr ()
  49 {
  50   delete _environment;
  51   delete _controller;
  52 }
  53
  54 void
  55 FGEnvironmentMgr::init ()
  56 {
  57   SG_LOG( SG_GENERAL, SG_INFO, "Initializing environment subsystem");
  58   SGSubsystemGroup::init();
  59   _update_fdm();
  60 }
  61
  62 void
  63 FGEnvironmentMgr::reinit ()
  64 {
  65   SG_LOG( SG_GENERAL, SG_INFO, "Reinitializing environment subsystem");
  66   SGSubsystemGroup::reinit();
  67   _update_fdm();
  68 }
  69
  70 void
  71 FGEnvironmentMgr::bind ()
  72 {
  73   fgTie("/environment/visibility-m", _environment,
  74         &FGEnvironment::get_visibility_m, &FGEnvironment::set_visibility_m);
  75   fgSetArchivable("/environment/visibility-m");
  76   fgTie("/environment/temperature-sea-level-degc", _environment,
  77         &FGEnvironment::get_temperature_sea_level_degc,
  78         &FGEnvironment::set_temperature_sea_level_degc);
  79   fgSetArchivable("/environment/temperature-sea-level-degc");
  80   fgTie("/environment/temperature-degc", _environment,
  81         &FGEnvironment::get_temperature_degc); // FIXME: read-only for now
  82   fgTie("/environment/dewpoint-sea-level-degc", _environment,
  83         &FGEnvironment::get_dewpoint_sea_level_degc,
  84         &FGEnvironment::set_dewpoint_sea_level_degc);
  85   fgSetArchivable("/environment/dewpoint-sea-level-degc");
  86   fgTie("/environment/dewpoint-degc", _environment,
  87         &FGEnvironment::get_dewpoint_degc); // FIXME: read-only for now
  88   fgTie("/environment/pressure-sea-level-inhg", _environment,
  89         &FGEnvironment::get_pressure_sea_level_inhg,
  90         &FGEnvironment::set_pressure_sea_level_inhg);
  91   fgSetArchivable("/environment/pressure-sea-level-inhg");
  92   fgTie("/environment/pressure-inhg", _environment,
  93         &FGEnvironment::get_pressure_inhg); // FIXME: read-only for now
  94   fgTie("/environment/density-slugft3", _environment,
  95         &FGEnvironment::get_density_slugft3); // read-only
  96   fgTie("/environment/wind-from-heading-deg", _environment,
  97         &FGEnvironment::get_wind_from_heading_deg,
  98         &FGEnvironment::set_wind_from_heading_deg);
  99   fgTie("/environment/wind-speed-kt", _environment,
 100         &FGEnvironment::get_wind_speed_kt, &FGEnvironment::set_wind_speed_kt);
 101   fgTie("/environment/wind-from-north-fps", _environment,
 102         &FGEnvironment::get_wind_from_north_fps,
 103         &FGEnvironment::set_wind_from_north_fps);
 104   fgSetArchivable("/environment/wind-from-north-fps");
 105   fgTie("/environment/wind-from-east-fps", _environment,
 106         &FGEnvironment::get_wind_from_east_fps,
 107         &FGEnvironment::set_wind_from_east_fps);
 108   fgSetArchivable("/environment/wind-from-east-fps");
 109   fgTie("/environment/wind-from-down-fps", _environment,
 110         &FGEnvironment::get_wind_from_down_fps,
 111         &FGEnvironment::set_wind_from_down_fps);
 112   fgSetArchivable("/environment/wind-from-down-fps");
 113   fgTie("/environment/turbulence/magnitude-norm", _environment,
 114         &FGEnvironment::get_turbulence_magnitude_norm,
 115         &FGEnvironment::set_turbulence_magnitude_norm);
 116   fgSetArchivable("/environment/turbulence/magnitude-norm");
 117   fgTie("/environment/turbulence/rate-hz", _environment,
 118         &FGEnvironment::get_turbulence_rate_hz,
 119         &FGEnvironment::set_turbulence_rate_hz);
 120   fgSetArchivable("/environment/turbulence/rate-hz");
 121
 122   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 123     char buf[128];
 124     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 125     fgTie(buf, this, i,
 126           &FGEnvironmentMgr::get_cloud_layer_span_m,
 127           &FGEnvironmentMgr::set_cloud_layer_span_m);
 128     fgSetArchivable(buf);
 129     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 130     fgTie(buf, this, i,
 131           &FGEnvironmentMgr::get_cloud_layer_elevation_ft,
 132           &FGEnvironmentMgr::set_cloud_layer_elevation_ft);
 133     fgSetArchivable(buf);
 134     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 135     fgTie(buf, this, i,
 136           &FGEnvironmentMgr::get_cloud_layer_thickness_ft,
 137           &FGEnvironmentMgr::set_cloud_layer_thickness_ft);
 138     fgSetArchivable(buf);
 139     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 140     fgTie(buf, this, i,
 141           &FGEnvironmentMgr::get_cloud_layer_transition_ft,
 142           &FGEnvironmentMgr::set_cloud_layer_transition_ft);
 143     fgSetArchivable(buf);
 144     sprintf(buf, "/environment/clouds/layer[%d]/coverage", i);
 145     fgTie(buf, this, i,
 146           &FGEnvironmentMgr::get_cloud_layer_coverage,
 147           &FGEnvironmentMgr::set_cloud_layer_coverage);
 148     fgSetArchivable(buf);
 149   }
 150 }
 151
 152 void
 153 FGEnvironmentMgr::unbind ()
 154 {
 155   fgUntie("/environment/visibility-m");
 156   fgUntie("/environment/temperature-sea-level-degc");
 157   fgUntie("/environment/temperature-degc");
 158   fgUntie("/environment/dewpoint-sea-level-degc");
 159   fgUntie("/environment/dewpoint-degc");
 160   fgUntie("/environment/pressure-sea-level-inhg");
 161   fgUntie("/environment/pressure-inhg");
 162   fgUntie("/environment/density-inhg");
 163   fgUntie("/environment/wind-from-north-fps");
 164   fgUntie("/environment/wind-from-east-fps");
 165   fgUntie("/environment/wind-from-down-fps");
 166   for (int i = 0; i < MAX_CLOUD_LAYERS; i++) {
 167     char buf[128];
 168     sprintf(buf, "/environment/clouds/layer[%d]/span-m", i);
 169     fgUntie(buf);
 170     sprintf(buf, "/environment/clouds/layer[%d]/elevation-ft", i);
 171     fgUntie(buf);
 172     sprintf(buf, "/environment/clouds/layer[%d]/thickness-ft", i);
 173     fgUntie(buf);
 174     sprintf(buf, "/environment/clouds/layer[%d]/transition-ft", i);
 175     fgUntie(buf);
 176     sprintf(buf, "/environment/clouds/layer[%d]/type", i);
 177     fgUntie(buf);
 178   }
 179 }
 180
 181 void
 182 FGEnvironmentMgr::update (double dt)
 183 {
 184   SGSubsystemGroup::update(dt);
 185
 186                                 // FIXME: the FDMs should update themselves
 187   current_aircraft.fdm_state
 188     ->set_Velocities_Local_Airmass(_environment->get_wind_from_north_fps(),
 189                                    _environment->get_wind_from_east_fps(),
 190                                    _environment->get_wind_from_down_fps());
 191   _environment->set_elevation_ft(fgGetDouble("/position/altitude-ft"));
 192
 193   _update_fdm();
 194 }
 195
 196 FGEnvironment
 197 FGEnvironmentMgr::getEnvironment () const
 198 {
 199   return *_environment;
 200 }
 201
 202 FGEnvironment
 203 FGEnvironmentMgr::getEnvironment (double lat, double lon, double alt) const
 204 {
 205                                 // Always returns the same environment
 206                                 // for now; we'll make it interesting
 207                                 // later.
 208   FGEnvironment env = *_environment;
 209   env.set_elevation_ft(alt);
 210   return env;
 211 }
 212
 213 void
 214 FGEnvironmentMgr::_update_fdm () const
 215 {
 216   //
 217   // Pass atmosphere on to FDM
 218   // FIXME: have FDMs read properties directly.
 219   //
 220   if (fgGetBool("/environment/params/control-fdm-atmosphere")) {
 221                                 // convert from Rankine to Celsius
 222     cur_fdm_state
 223       ->set_Static_temperature((9.0/5.0)
 224                                * (_environment->get_temperature_degc() + 273.15));
 225                                 // convert from inHG to PSF
 226     cur_fdm_state
 227       ->set_Static_pressure(_environment->get_pressure_inhg() * 70.726566);
 228                                 // keep in slugs/ft^3
 229     cur_fdm_state
 230       ->set_Density(_environment->get_density_slugft3());
 231   }
 232 }
 233
 234 double
 235 FGEnvironmentMgr::get_cloud_layer_span_m (int index) const
 236 {
 237   return thesky->get_cloud_layer(index)->getSpan_m();
 238 }
 239
 240 void
 241 FGEnvironmentMgr::set_cloud_layer_span_m (int index, double span_m)
 242 {
 243   thesky->get_cloud_layer(index)->setSpan_m(span_m);
 244 }
 245
 246 double
 247 FGEnvironmentMgr::get_cloud_layer_elevation_ft (int index) const
 248 {
 249   return thesky->get_cloud_layer(index)->getElevation_m() * SG_METER_TO_FEET;
 250 }
 251
 252 void
 253 FGEnvironmentMgr::set_cloud_layer_elevation_ft (int index, double elevation_ft)
 254 {
 255   FGEnvironment env = *_environment;
 256   env.set_elevation_ft(elevation_ft);
 257
 258   thesky->get_cloud_layer(index)
 259     ->setElevation_m(elevation_ft * SG_FEET_TO_METER);
 260
 261   thesky->get_cloud_layer(index)
 262     ->setSpeed(env.get_wind_speed_kt() * 0.5151);       // 1 kt = 0.5151 m/s
 263
 264   thesky->get_cloud_layer(index)
 265     ->setDirection(env.get_wind_from_heading_deg());
 266 }
 267
 268 double
 269 FGEnvironmentMgr::get_cloud_layer_thickness_ft (int index) const
 270 {
 271   return thesky->get_cloud_layer(index)->getThickness_m() * SG_METER_TO_FEET;
 272 }
 273
 274 void
 275 FGEnvironmentMgr::set_cloud_layer_thickness_ft (int index, double thickness_ft)
 276 {
 277   thesky->get_cloud_layer(index)
 278     ->setThickness_m(thickness_ft * SG_FEET_TO_METER);
 279 }
 280
 281 double
 282 FGEnvironmentMgr::get_cloud_layer_transition_ft (int index) const
 283 {
 284   return thesky->get_cloud_layer(index)->getTransition_m() * SG_METER_TO_FEET;
 285 }
 286
 287 void
 288 FGEnvironmentMgr::set_cloud_layer_transition_ft (int index,
 289                                                  double transition_ft)
 290 {
 291   thesky->get_cloud_layer(index)
 292     ->setTransition_m(transition_ft * SG_FEET_TO_METER);
 293 }
 294
 295 const char *
 296 FGEnvironmentMgr::get_cloud_layer_coverage (int index) const
 297 {
 298   switch (thesky->get_cloud_layer(index)->getCoverage()) {
 299   case SGCloudLayer::SG_CLOUD_OVERCAST:
 300     return "overcast";
 301   case SGCloudLayer::SG_CLOUD_BROKEN:
 302     return "broken";
 303   case SGCloudLayer::SG_CLOUD_SCATTERED:
 304     return "scattered";
 305   case SGCloudLayer::SG_CLOUD_FEW:
 306     return "few";
 307   case SGCloudLayer::SG_CLOUD_CIRRUS:
 308     return "cirrus";
 309   case SGCloudLayer::SG_CLOUD_CLEAR:
 310     return "clear";
 311   default:
 312     return "unknown";
 313   }
 314 }
 315
 316 void
 317 FGEnvironmentMgr::set_cloud_layer_coverage (int index,
 318                                             const char * coverage_name)
 319 {
 320   SGCloudLayer::Coverage coverage;
 321   if (!strcmp(coverage_name, "overcast"))
 322     coverage = SGCloudLayer::SG_CLOUD_OVERCAST;
 323   else if (!strcmp(coverage_name, "broken"))
 324     coverage = SGCloudLayer::SG_CLOUD_BROKEN;
 325   else if (!strcmp(coverage_name, "scattered"))
 326     coverage = SGCloudLayer::SG_CLOUD_SCATTERED;
 327   else if (!strcmp(coverage_name, "few"))
 328     coverage = SGCloudLayer::SG_CLOUD_FEW;
 329   else if (!strcmp(coverage_name, "cirrus"))
 330     coverage = SGCloudLayer::SG_CLOUD_CIRRUS;
 331   else if (!strcmp(coverage_name, "clear"))
 332     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 333   else {
 334     SG_LOG(SG_INPUT, SG_WARN, "Unknown cloud type " << coverage_name);
 335     coverage = SGCloudLayer::SG_CLOUD_CLEAR;
 336   }
 337   thesky->get_cloud_layer(index)->setCoverage(coverage);
 338 }
 339
 340
 341
 342 // end of environment-mgr.cxx