src/Instrumentation/kr_87.hxx

   1 // kr-87.hxx -- class to impliment the King KR 87 Digital ADF
   2 //
   3 // Written by Curtis Olson, started June 2002.
   4 //
   5 // Copyright (C) 2002  Curtis L. Olson - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _FG_KR_87_HXX
  25 #define _FG_KR_87_HXX
  26
  27
  28 #include <Main/fg_props.hxx>
  29
  30 #include <simgear/compiler.h>
  31 #include <simgear/structure/subsystem_mgr.hxx>
  32 #include <simgear/timing/timestamp.hxx>
  33
  34 #include <Navaids/navlist.hxx>
  35 #include <Sound/morse.hxx>
  36
  37 class SGSampleGroup;
  38
  39 class FGKR_87 : public SGSubsystem
  40 {
  41     FGMorse morse;
  42
  43     SGPropertyNode_ptr lon_node;
  44     SGPropertyNode_ptr lat_node;
  45     SGPropertyNode_ptr alt_node;
  46     SGPropertyNode_ptr bus_power;
  47     SGPropertyNode_ptr serviceable;
  48
  49     bool need_update;
  50
  51     // internal values
  52     string ident;
  53     string trans_ident;
  54     bool valid;
  55     bool inrange;
  56     double stn_lon;
  57     double stn_lat;
  58     double stn_elev;
  59     double range;
  60     double effective_range;
  61     double dist;
  62     double heading;
  63     SGVec3d xyz;
  64     double goal_needle_deg;
  65     double et_flash_time;
  66
  67     // modes
  68     int ant_mode;               // 0 = ADF mode (needle active), 1 = ANT mode
  69                                 // (needle turned to 90, improved audio rcpt)
  70     int stby_mode;              // 0 = show stby freq, 1 = show timer
  71     int timer_mode;             // 0 = flt, 1 = et
  72     int count_mode;             // 0 = count up, 1 = count down, 2 = set et
  73                                 // count down
  74
  75     // input and buttons
  76     double rotation;            // compass faceplace rotation
  77     bool power_btn;             // 0 = off, 1 = powered
  78     bool audio_btn;             // 0 = off, 1 = on
  79     double vol_btn;
  80     bool adf_btn;               // 0 = normal, 1 = depressed
  81     bool bfo_btn;               // 0 = normal, 1 = depressed
  82     bool frq_btn;               // 0 = normal, 1 = depressed
  83     bool last_frq_btn;
  84     bool flt_et_btn;            // 0 = normal, 1 = depressed
  85     bool last_flt_et_btn;
  86     bool set_rst_btn;           // 0 = normal, 1 = depressed
  87     bool last_set_rst_btn;      // 0 = normal, 1 = depressed
  88
  89     // outputs
  90     int freq;
  91     int stby_freq;
  92     double needle_deg;
  93     double flight_timer;
  94     double elapsed_timer;
  95     double tmp_timer;
  96
  97     // annunciators
  98     bool ant_ann;
  99     bool adf_ann;
 100     bool bfo_ann;
 101     bool frq_ann;
 102     bool flt_ann;
 103     bool et_ann;
 104
 105     // internal periodic station search timer
 106     double _time_before_search_sec;
 107
 108     SGSampleGroup *_sgr;
 109
 110 public:
 111
 112     FGKR_87( SGPropertyNode *node );
 113     ~FGKR_87();
 114
 115     void init ();
 116     void bind ();
 117     void unbind ();
 118     void update (double dt_sec);
 119
 120     // Update nav/adf radios based on current postition
 121     void search ();
 122
 123     // internal values
 124     inline const string& get_ident() const { return ident; }
 125     inline bool get_valid() const { return valid; }
 126     inline bool get_inrange() const { return inrange; }
 127     inline double get_stn_lon() const { return stn_lon; }
 128     inline double get_stn_lat() const { return stn_lat; }
 129     inline double get_dist() const { return dist; }
 130     inline double get_heading() const { return heading; }
 131     inline bool has_power() const {
 132         return power_btn && (bus_power->getDoubleValue() > 1.0);
 133     }
 134
 135     // modes
 136     inline int get_ant_mode() const { return ant_mode; }
 137     inline int get_stby_mode() const { return stby_mode; }
 138     inline int get_timer_mode() const { return timer_mode; }
 139     inline int get_count_mode() const { return count_mode; }
 140
 141     // input and buttons
 142     inline double get_rotation () const { return rotation; }
 143     inline void set_rotation( double rot ) { rotation = rot; }
 144     inline bool get_power_btn() const { return power_btn; }
 145     inline void set_power_btn( bool val ) {
 146         power_btn = val;
 147     }
 148     inline bool get_audio_btn() const { return audio_btn; }
 149     inline void set_audio_btn( bool val ) {
 150         audio_btn = val;
 151     }
 152     inline double get_vol_btn() const { return vol_btn; }
 153     inline void set_vol_btn( double val ) {
 154         if ( val < 0.0 ) val = 0.0;
 155         if ( val > 1.0 ) val = 1.0;
 156         vol_btn = val;
 157     }
 158     inline bool get_adf_btn() const { return adf_btn; }
 159     inline void set_adf_btn( bool val ) { adf_btn = val; }
 160     inline bool get_bfo_btn() const { return bfo_btn; }
 161     inline void set_bfo_btn( bool val ) { bfo_btn = val; }
 162     inline bool get_frq_btn() const { return frq_btn; }
 163     inline void set_frq_btn( bool val ) { frq_btn = val; }
 164     inline bool get_flt_et_btn() const { return flt_et_btn; }
 165     inline void set_flt_et_btn( bool val ) { flt_et_btn = val; }
 166     inline bool get_set_rst_btn() const { return set_rst_btn; }
 167     inline void set_set_rst_btn( bool val ) { set_rst_btn = val; }
 168
 169     // outputs
 170     inline int get_freq () const { return freq; }
 171     inline void set_freq( int f ) {
 172         freq = f;
 173         need_update = true;
 174     }
 175     int get_stby_freq () const;
 176     inline void set_stby_freq( int f ) { stby_freq = f; }
 177     inline double get_needle_deg() const { return needle_deg; }
 178     inline double get_flight_timer() const { return flight_timer; }
 179     inline double get_elapsed_timer() const { return elapsed_timer; }
 180     inline void set_elapsed_timer( double val ) { elapsed_timer = val; }
 181
 182     // annunciators
 183     inline bool get_ant_ann() const { return ant_ann; }
 184     inline bool get_adf_ann() const { return adf_ann; }
 185     inline bool get_bfo_ann() const { return bfo_ann; }
 186     inline bool get_frq_ann() const { return frq_ann; }
 187     inline bool get_flt_ann() const { return flt_ann; }
 188     inline bool get_et_ann() const { return et_ann; }
 189 };
 190
 191
 192 #endif // _FG_KR_87_HXX