src/Environment/environment.hxx

   1 // environment.hxx -- routines to model the natural environment.
   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
  24 #ifndef _ENVIRONMENT_HXX
  25 #define _ENVIRONMENT_HXX
  26
  27 #include <simgear/compiler.h>
  28
  29 #include <Main/fgfs.hxx>
  30
  31 #ifdef SG_HAVE_STD_INCLUDES
  32 #  include <cmath>
  33 #else
  34 #  include <math.h>
  35 #endif
  36
  37
  38 /**
  39  * Model the natural environment.
  40  *
  41  * This class models the natural environment at a specific place and
  42  * time.  A separate instance is necessary for each location or time.
  43  *
  44  * This class should eventually move to SimGear.
  45  */
  46 class FGEnvironment
  47 {
  48
  49 public:
  50
  51   FGEnvironment();
  52   FGEnvironment (const FGEnvironment &environment);
  53   virtual ~FGEnvironment();
  54
  55   virtual void copy (const FGEnvironment &environment);
  56
  57   virtual void read (const SGPropertyNode * node);
  58
  59   virtual double get_visibility_m () const;
  60
  61   virtual double get_temperature_sea_level_degc () const;
  62   virtual double get_temperature_degc () const;
  63   virtual double get_dewpoint_sea_level_degc () const;
  64   virtual double get_dewpoint_degc () const;
  65   virtual double get_pressure_sea_level_inhg () const;
  66   virtual double get_pressure_inhg () const;
  67   virtual double get_density_slugft3 () const;
  68
  69   virtual double get_wind_from_heading_deg () const;
  70   virtual double get_wind_speed_kt () const;
  71   virtual double get_wind_from_north_fps () const;
  72   virtual double get_wind_from_east_fps () const;
  73   virtual double get_wind_from_down_fps () const;
  74
  75   virtual double get_turbulence_magnitude_norm () const;
  76   virtual double get_turbulence_rate_hz () const;
  77
  78   virtual void set_visibility_m (double v);
  79
  80   virtual void set_temperature_sea_level_degc (double t);
  81   virtual void set_temperature_degc (double t);
  82   virtual void set_dewpoint_sea_level_degc (double d);
  83   virtual void set_dewpoint_degc (double d);
  84   virtual void set_pressure_sea_level_inhg (double p);
  85   virtual void set_pressure_inhg (double p);
  86
  87   virtual void set_wind_from_heading_deg (double h);
  88   virtual void set_wind_speed_kt (double s);
  89   virtual void set_wind_from_north_fps (double n);
  90   virtual void set_wind_from_east_fps (double e);
  91   virtual void set_wind_from_down_fps (double d);
  92
  93   virtual void set_turbulence_magnitude_norm (double t);
  94   virtual void set_turbulence_rate_hz (double t);
  95
  96   virtual double get_elevation_ft () const;
  97   virtual void set_elevation_ft (double elevation_ft);
  98
  99 private:
 100
 101   void _recalc_hdgspd ();
 102   void _recalc_ne ();
 103
 104   void _recalc_sl_temperature ();
 105   void _recalc_alt_temperature ();
 106   void _recalc_sl_dewpoint ();
 107   void _recalc_alt_dewpoint ();
 108   void _recalc_sl_pressure ();
 109   void _recalc_alt_pressure ();
 110   void _recalc_density ();
 111
 112   double elevation_ft;
 113
 114   double visibility_m;
 115
 116                                 // Atmosphere
 117   double temperature_sea_level_degc;
 118   double temperature_degc;
 119   double dewpoint_sea_level_degc;
 120   double dewpoint_degc;
 121   double pressure_sea_level_inhg;
 122   double pressure_inhg;
 123   double density_slugft3;
 124
 125   double turbulence_magnitude_norm;
 126   double turbulence_rate_hz;
 127
 128   double wind_from_heading_deg;
 129   double wind_speed_kt;
 130
 131   double wind_from_north_fps;
 132   double wind_from_east_fps;
 133   double wind_from_down_fps;
 134
 135 };
 136
 137 void interpolate (const FGEnvironment * env1, const FGEnvironment * env2,
 138                   double fraction, FGEnvironment * result);
 139
 140 #endif // _ENVIRONMENT_HXX