]> git.mxchange.org Git - flightgear.git/blob - src/Instrumentation/adf.hxx
ADF: code clean-up/documentation
[flightgear.git] / src / Instrumentation / adf.hxx
1 // adf.hxx - automatic direction finder.
2 // Written by David Megginson, started 2003.
3 //
4 // This file is in the Public Domain and comes with no warranty.
5
6
7 #ifndef __INSTRUMENTS_ADF_HXX
8 #define __INSTRUMENTS_ADF_HXX 1
9
10 #ifndef __cplusplus
11 # error This library requires C++
12 #endif
13
14 #include <string>
15
16 #include <simgear/props/props.hxx>
17
18 #include <simgear/structure/subsystem_mgr.hxx>
19
20 using std::string;
21
22
23 class SGSampleGroup;
24
25 /**
26  * Model an ADF radio.
27  *
28  * Input properties:
29  *
30  * /position/longitude-deg
31  * /position/latitude-deg
32  * /position/altitude-ft
33  * /orientation/heading-deg
34  * /systems/electrical/outputs/adf
35  * /instrumentation/adf/serviceable
36  * /instrumentation/adf/error-deg
37  * /instrumentation/adf/frequencies/selected-khz
38  * /instrumentation/adf/mode
39  * /instrumentation/adf/ident-audible
40  * /instrumentation/adf/volume-norm
41  *
42  * Output properties:
43  *
44  * /instrumentation/adf/in-range
45  * /instrumentation/adf/indicated-bearing-deg
46  * /instrumentation/adf/ident
47  */
48 class ADF : public SGSubsystem
49 {
50
51 public:
52
53     ADF ( SGPropertyNode *node );
54     virtual ~ADF ();
55
56     virtual void init ();
57     virtual void update (double delta_time_sec);
58
59 private:
60
61     void set_bearing (double delta_time_sec, double bearing);
62
63     void search (double frequency, double longitude_rad,
64                  double latitude_rad, double altitude_m);
65
66     std::string _name;
67     unsigned int _num;
68
69     SGPropertyNode_ptr _longitude_node;
70     SGPropertyNode_ptr _latitude_node;
71     SGPropertyNode_ptr _altitude_node;
72     SGPropertyNode_ptr _heading_node;
73     SGPropertyNode_ptr _serviceable_node;
74     SGPropertyNode_ptr _error_node;
75     SGPropertyNode_ptr _electrical_node;
76     SGPropertyNode_ptr _frequency_node;
77     SGPropertyNode_ptr _mode_node;
78
79     SGPropertyNode_ptr _in_range_node;
80     SGPropertyNode_ptr _bearing_node;
81     SGPropertyNode_ptr _ident_node;
82     SGPropertyNode_ptr _ident_audible_node;
83     SGPropertyNode_ptr _volume_node;
84     SGPropertyNode_ptr _power_btn_node;
85     SGPropertyNode_ptr _operable_node;
86
87     double _time_before_search_sec;
88
89     int _last_frequency_khz;
90     bool _transmitter_valid;
91     string _last_ident;
92     SGGeod _transmitter_pos;
93     SGVec3d _transmitter_cart;
94     double _transmitter_range_nm;
95
96     int _ident_count;
97     time_t _last_ident_time;
98     float _last_volume;
99     string _adf_ident;
100
101     SGSharedPtr<SGSampleGroup> _sgr;
102 };
103
104
105 #endif // __INSTRUMENTS_ADF_HXX