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