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 #include <simgear/structure/subsystem_mgr.hxx>
  16
  17
  18 /**
  19  * Model a magnetic compass.
  20  *
  21  * Input properties:
  22  *
  23  * /instrumentation/magnetic-compass/serviceable
  24  * /orientation/heading-deg
  25  * /orientation/beta-deg
  26  * /environment/magnetic-variation-deg
  27  * /environment/magnetic-dip-deg
  28  * /accelerations/ned/north-accel-fps_sec
  29  * /accelerations/ned/east-accel-fps_sec
  30  * /accelerations/ned/down-accel-fps_sec
  31  *
  32  * Output properties:
  33  *
  34  * /instrumentation/magnetic-compass/indicated-heading-deg
  35  */
  36 class MagCompass : public SGSubsystem
  37 {
  38
  39 public:
  40
  41     MagCompass ();
  42     virtual ~MagCompass ();
  43
  44     virtual void init ();
  45     virtual void update (double dt);
  46
  47 private:
  48
  49     double _error_deg;
  50     double _rate_degps;
  51
  52     SGPropertyNode_ptr _serviceable_node;
  53     SGPropertyNode_ptr _heading_node;
  54     SGPropertyNode_ptr _beta_node;
  55     SGPropertyNode_ptr _variation_node;
  56     SGPropertyNode_ptr _dip_node;
  57     SGPropertyNode_ptr _y_accel_node;
  58     SGPropertyNode_ptr _z_accel_node;
  59     SGPropertyNode_ptr _north_accel_node;
  60     SGPropertyNode_ptr _east_accel_node;
  61     SGPropertyNode_ptr _down_accel_node;
  62     SGPropertyNode_ptr _out_node;
  63
  64 };
  65
  66 #endif // __INSTRUMENTS_MAG_COMPASS_HXX