simgear/magvar/magvar.hxx

   1 /**
   2  * \file magvar.hxx
   3  * Magnetic variation wrapper class.
   4  */
   5
   6 // Written by Curtis Olson, started July 2000.
   7 //
   8 // Copyright (C) 2000  Curtis L. Olson  - curt@flightgear.org
   9 //
  10 // This program is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU General Public License as
  12 // published by the Free Software Foundation; either version 2 of the
  13 // License, or (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful, but
  16 // WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 // General Public License for more details.
  19 //
  20 // You should have received a copy of the GNU General Public License
  21 // along with this program; if not, write to the Free Software
  22 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23 //
  24 // $Id$
  25
  26
  27 #ifndef _MAGVAR_HXX
  28 #define _MAGVAR_HXX
  29
  30
  31 #ifndef __cplusplus
  32 # error This library requires C++
  33 #endif
  34
  35
  36 /**
  37  * Magnetic variation wrapper class.
  38  *
  39  * The SGMagVar class calculates the magnetic variation and dip for
  40  * any position, altitude, and time. It is a complete
  41  * re-implimentation of the NIMA WMM 2000 (not derived from their demo
  42  * code.)
  43  *
  44  * The SGMagVar class is really a simple wrapper around the core Ed
  45  * Williams code which does all the hard work.  This class allows you
  46  * to crunch the math once and then do multiple polls of the
  47  * data. However, if your position, altitude, or time has changed
  48  * significantly, you should call the update() method to recrunch new
  49  * numbers.
  50  */
  51 class SGMagVar {
  52
  53 private:
  54
  55     double magvar;
  56     double magdip;
  57
  58 public:
  59
  60     /**
  61      * This creates an instance of the SGMagVar object.
  62      * You must call the update() method before any queries will be valid.
  63      */
  64     SGMagVar();
  65
  66     /** Destructor */
  67     ~SGMagVar();
  68
  69     /** Recalculate the magnetic offset and dip.
  70      * The update() method requires you to pass in your position and
  71      * the julian date. Lon and lat are specified in radians, altitude
  72      * is specified in meters. Julian date can be conveniently
  73      * calculated by using an instance of the SGTime class.
  74      * @param lon longitude in radians
  75      * @param lat latitude in radians
  76      * @param alt_m altitude above sea level in meters
  77      * @param jd julian date
  78      */
  79     void update( double lon, double lat, double alt_m, double jd );
  80
  81     /** @return the current magnetic variation in radians. */
  82     double get_magvar() const { return magvar; }
  83
  84     /** @return the current magnetic dip in radians. */
  85     double get_magdip() const { return magdip; }
  86 };
  87
  88
  89 /**
  90  * \relates SGMagVar
  91  * Lookup the magvar for any arbitrary location (This function doesn't
  92  * save state like the SGMagVar class.  This function triggers a fair
  93  * amount of CPU work, so use it cautiously.
  94  * @return the magvar in radians
  95  */
  96 double sgGetMagVar( double lon, double lat, double alt_m, double jd );
  97
  98
  99 #endif // _MAGVAR_HXX