src/Instrumentation/mag_compass.hxx

   1 // mag_compass.hxx - an altimeter tied to the static port.
   2 // Written by David Megginson, started 2002.
   3 //
   4 // This file is in the Public Domain and comes with no warranty.
   5
   6
   7 #ifndef __INSTRUMENTS_MAG_COMPASS_HXX
   8 #define __INSTRUMENTS_MAG_COMPASS_HXX 1
   9
  10 #ifndef __cplusplus
  11 # error This library requires C++
  12 #endif
  13
  14 #include <simgear/props/props.hxx>
  15
  16 #include <Main/fgfs.hxx>
  17
  18
  19 /**
  20  * Model a magnetic compass.
  21  *
  22  * Input properties:
  23  *
  24  * /instrumentation/magnetic-compass/serviceable
  25  * /orientation/heading-deg
  26  * /orientation/beta-deg
  27  * /environment/magnetic-variation-deg
  28  * /environment/magnetic-dip-deg
  29  * /accelerations/ned/north-accel-fps_sec
  30  * /accelerations/ned/east-accel-fps_sec
  31  * /accelerations/ned/down-accel-fps_sec
  32  *
  33  * Output properties:
  34  *
  35  * /instrumentation/magnetic-compass/indicated-heading-deg
  36  */
  37 class MagCompass : public FGSubsystem
  38 {
  39
  40 public:
  41
  42     MagCompass ();
  43     virtual ~MagCompass ();
  44
  45     virtual void init ();
  46     virtual void update (double dt);
  47
  48 private:
  49
  50     double _error_deg;
  51     double _rate_degps;
  52
  53     SGPropertyNode_ptr _serviceable_node;
  54     SGPropertyNode_ptr _heading_node;
  55     SGPropertyNode_ptr _beta_node;
  56     SGPropertyNode_ptr _variation_node;
  57     SGPropertyNode_ptr _dip_node;
  58     SGPropertyNode_ptr _y_accel_node;
  59     SGPropertyNode_ptr _z_accel_node;
  60     SGPropertyNode_ptr _north_accel_node;
  61     SGPropertyNode_ptr _east_accel_node;
  62     SGPropertyNode_ptr _down_accel_node;
  63     SGPropertyNode_ptr _out_node;
  64
  65 };
  66
  67 #endif // __INSTRUMENTS_MAG_COMPASS_HXX