]> git.mxchange.org Git - flightgear.git/blob - src/Instrumentation/tacan.cxx
81627abff212693f157632ca9066b4af800ad64b
[flightgear.git] / src / Instrumentation / tacan.cxx
1 // tacan.cxx - Tactical Navigation Beacon.
2 // Written by Vivian Meazaa, started 2005.
3 //
4 // This file is in the Public Domain and comes with no warranty.
5
6 #ifdef HAVE_CONFIG_H
7 #  include <config.h>
8 #endif
9
10 #include <simgear/compiler.h>
11 #include <simgear/math/sg_geodesy.hxx>
12 #include <simgear/math/sg_random.h>
13
14 #include <Main/fg_props.hxx>
15 #include <Navaids/navlist.hxx>
16 #include <vector>
17
18 #include "tacan.hxx"
19
20 SG_USING_STD(vector);
21
22
23 /**
24  * Adjust the range.
25  *
26  * Start by calculating the radar horizon based on the elevation
27  * difference, then clamp to the maximum, then add a fudge for
28  * borderline reception.
29  */
30 static double
31 adjust_range (double transmitter_elevation_ft, double aircraft_altitude_ft,
32               double max_range_nm)
33 {
34     max_range_nm = 150;
35     double delta_elevation_ft =
36         fabs(aircraft_altitude_ft - transmitter_elevation_ft);
37     double range_nm = 1.23 * sqrt(delta_elevation_ft);
38     if (range_nm > max_range_nm)
39         range_nm = max_range_nm;
40     else if (range_nm < 20.0)
41         range_nm = 20.0;
42     double rand = sg_random();
43     SG_LOG( SG_INSTR, SG_DEBUG, " tacan range " << range_nm << " max range " << max_range_nm);
44     return range_nm + (range_nm * rand * rand);
45 }
46
47
48 TACAN::TACAN ( SGPropertyNode *node )
49     : _last_distance_nm(0),
50       _last_frequency_mhz(-1),
51       _time_before_search_sec(0),
52       _carrier_valid(false),
53       _transmitter_valid(false),
54       _transmitter_elevation_ft(0),
55       _transmitter_range_nm(0),
56       _transmitter_bias(0.0),
57
58       name("tacan"),
59       num(0)
60 {
61
62     int i;
63     for ( i = 0; i < node->nChildren(); ++i ) {
64         SGPropertyNode *child = node->getChild(i);
65         string cname = child->getName();
66         string cval = child->getStringValue();
67         if ( cname == "name" ) {
68             name = cval;
69         } else if ( cname == "number" ) {
70             num = child->getIntValue();
71         } else {
72             SG_LOG( SG_INSTR, SG_DEBUG, "Error in TACAN config logic" );
73             if ( name.length() ) {
74                 SG_LOG( SG_INSTR, SG_DEBUG, "Section = " << name );
75             }
76         }
77     }
78 }
79
80 TACAN::TACAN ()
81     : _last_distance_nm(0),
82       _last_frequency_mhz(-1),
83       _time_before_search_sec(0),
84       _carrier_valid(false),
85       _transmitter_valid(false),
86       _transmitter_elevation_ft(0),
87       _transmitter_range_nm(0),
88       _transmitter_bearing_deg(0),
89       _transmitter_bias(0.0),
90       _transmitter_name(""),
91       name("tacan")
92 {
93 }
94
95 TACAN::~TACAN ()
96 {
97 }
98
99 void
100 TACAN::init ()
101 {
102     string branch;
103     branch = "/instrumentation/" + name;
104
105     SGPropertyNode *node = fgGetNode(branch.c_str(), num, true );
106
107     _longitude_node = fgGetNode("/position/longitude-deg", true);
108     _latitude_node = fgGetNode("/position/latitude-deg", true);
109     _altitude_node = fgGetNode("/position/altitude-ft", true);
110     _heading_node   = fgGetNode("/orientation/heading-deg", true);
111     _yaw_node       = fgGetNode("/orientation/side-slip-deg", true);
112     _serviceable_node = node->getChild("serviceable", 0, true);
113     _electrical_node = fgGetNode("/systems/electrical/outputs/tacan", true);
114     SGPropertyNode *fnode = node->getChild("frequencies", 0, true);
115     _source_node = fnode->getChild("source", 0, true);
116     _frequency_node = fnode->getChild("selected-mhz", 0, true);
117     _channel_node = fnode->getChild("selected-channel", 1, true);
118     _channel_node = fnode->getChild("selected-channel", 2, true);
119     _channel_node = fnode->getChild("selected-channel", 3, true);
120     _channel_node = fnode->getChild("selected-channel", 4, true);
121     _in_range_node = node->getChild("in-range", 0, true);
122     _distance_node = node->getChild("indicated-distance-nm", 0, true);
123     _speed_node = node->getChild("indicated-ground-speed-kt", 0, true);
124     _time_node = node->getChild("indicated-time-min", 0, true);
125     _name_node = node->getChild("name", 0, true);
126     _bearing_node = node->getChild("indicated-bearing-true-deg", 0, true);
127     SGPropertyNode *dnode = node->getChild("display", 0, true);
128     _x_shift_node = dnode->getChild("x-shift", 0, true);
129     _y_shift_node = dnode->getChild("y-shift", 0, true);
130     _rotation_node = dnode->getChild("rotation", 0, true);
131     _channel_node = dnode->getChild("channel", 0, true);
132
133     SGPropertyNode *cnode = fgGetNode("/ai/models/carrier", num, false );
134     if (cnode)
135         _carrier_name_node = cnode->getChild("name", 0, false);
136
137     SGPropertyNode *tnode = fgGetNode("/ai/models/aircraft", num, false);
138     if (tnode)
139         _tanker_callsign_node = tnode->getChild("callsign", 0, false);
140 }
141
142 void
143 TACAN::update (double delta_time_sec)
144 {
145     double az2 = 0;
146     double bearing = 0;
147     double distance = 0;
148     double carrier_az2 = 0;
149     double carrier_bearing = 0;
150     double carrier_distance = 0;
151     double tanker_az2 = 0;
152     double tanker_bearing = 0;
153     double tanker_distance = 0;
154     double frequency_mhz = 0;
155     double mobile_bearing = 0;
156     double mobile_distance = 0;
157     double mobile_elevation_ft = 0;
158     double mobile_range_nm = 0;
159     double mobile_bias = 0;
160     string mobile_name = "";
161     bool   mobile_valid = false;
162
163     string _channel, _last_channel, _channel_1, _channel_2,_channel_3, _channel_4;
164
165                                 // If it's off, don't waste any time.
166     if (!_serviceable_node->getBoolValue() || !_electrical_node->getBoolValue()) {
167         _last_distance_nm = 0;
168         _in_range_node->setBoolValue(false);
169         _distance_node->setDoubleValue(0);
170         _speed_node->setDoubleValue(0);
171         _time_node->setDoubleValue(0);
172         SG_LOG( SG_INSTR, SG_DEBUG, "skip tacan" );
173         return;
174     }
175
176                                 // Figure out the source
177     const char * source = _source_node->getStringValue();
178
179     if (source[0] == '\0') {
180         string branch;
181         branch = "/instrumentation/" + name + "/frequencies/selected-channel";
182         _source_node->setStringValue(branch.c_str());
183         source = _source_node->getStringValue();
184         SG_LOG( SG_INSTR, SG_DEBUG, "source " << source  );
185     }
186                                 // Get the channel
187     _channel_1 = fgGetString("/instrumentation/tacan/frequencies/selected-channel[1]");
188     _channel_2 = fgGetString("/instrumentation/tacan/frequencies/selected-channel[2]");
189     _channel_3 = fgGetString("/instrumentation/tacan/frequencies/selected-channel[3]");
190     _channel_4 = fgGetString("/instrumentation/tacan/frequencies/selected-channel[4]");
191
192     SG_LOG( SG_INSTR, SG_DEBUG, "channels " << _channel_1 << _channel_2 << _channel_3 << _channel_4);
193
194     _channel = _channel_1 + _channel_2 + _channel_3 + _channel_4;
195
196                                     // Get the frequency
197     if (_channel != _last_channel) {
198         _time_before_search_sec = 0;
199         _last_channel = _channel;
200         frequency_mhz = searchChannel(_channel);
201         SG_LOG( SG_INSTR, SG_DEBUG, "frequency " << frequency_mhz );
202         _frequency_node->setDoubleValue(frequency_mhz);
203     }
204
205     SG_LOG( SG_INSTR, SG_DEBUG, "channel " << _channel );
206                                 // Get the aircraft position
207     double longitude_deg = _longitude_node->getDoubleValue();
208     double latitude_deg  = _latitude_node->getDoubleValue();
209     double altitude_m    = _altitude_node->getDoubleValue() * SG_FEET_TO_METER;
210     double heading       = _heading_node->getDoubleValue() ;
211     double yaw           = _yaw_node->getDoubleValue() ;
212     double longitude_rad = longitude_deg * SGD_DEGREES_TO_RADIANS;
213     double latitude_rad  = latitude_deg * SGD_DEGREES_TO_RADIANS;
214
215                                 // On timeout, scan again
216     _time_before_search_sec -= delta_time_sec;
217     if (_time_before_search_sec < 0 && frequency_mhz >= 0)
218         search(frequency_mhz, longitude_rad, latitude_rad, altitude_m);
219
220                                  // Calculate the distance to the transmitter
221
222     //calculate the bearing and range of the carrier from the aircraft
223     SG_LOG( SG_INSTR, SG_DEBUG, "carrier_lat " << _carrier_lat);
224     SG_LOG( SG_INSTR, SG_DEBUG, "carrier_lon " << _carrier_lon);
225     SG_LOG( SG_INSTR, SG_DEBUG, "carrier_name " << _carrier_name);
226     SG_LOG( SG_INSTR, SG_DEBUG, "carrier_valid " << _carrier_valid);
227     geo_inverse_wgs_84(altitude_m,
228                        latitude_deg,
229                        longitude_deg,
230                        _carrier_lat,
231                        _carrier_lon,
232                        &carrier_bearing, &carrier_az2, &carrier_distance);
233
234     //calculate the bearing and range of the tanker from the aircraft
235     SG_LOG( SG_INSTR, SG_DEBUG, "tanker_lat " << _tanker_lat);
236     SG_LOG( SG_INSTR, SG_DEBUG, "tanker_lon " << _tanker_lon);
237     SG_LOG( SG_INSTR, SG_DEBUG, "tanker_name " << _tanker_name);
238     SG_LOG( SG_INSTR, SG_DEBUG, "tanker_valid " << _tanker_valid);
239     geo_inverse_wgs_84(altitude_m,
240                        latitude_deg,
241                        longitude_deg,
242                        _tanker_lat,
243                        _tanker_lon,
244                        &tanker_bearing, &tanker_az2, &tanker_distance);
245
246
247     //calculate the bearing and range of the station from the aircraft
248     geo_inverse_wgs_84(altitude_m,
249                        latitude_deg,
250                        longitude_deg,
251                        _transmitter_lat,
252                        _transmitter_lon,
253                        &bearing, &az2, &distance);
254
255     //select the nearest valid mobile transmitter
256     if ( _carrier_valid && _tanker_valid ){
257         if( carrier_distance <= tanker_distance ){
258             SG_LOG( SG_INSTR, SG_DEBUG, " select carrier (dist) " );
259             mobile_bearing = carrier_bearing;
260             mobile_distance = carrier_distance;
261             mobile_elevation_ft = _carrier_elevation_ft;
262             mobile_range_nm = _carrier_range_nm;
263             mobile_bias = _carrier_bias;
264             mobile_name = _carrier_name;
265         }else{
266             SG_LOG( SG_INSTR, SG_DEBUG, " select tanker (dist)  " );
267             mobile_bearing = tanker_bearing;
268             mobile_distance = tanker_distance;
269             mobile_elevation_ft = _tanker_elevation_ft;
270             mobile_range_nm = _tanker_range_nm;
271             mobile_bias = _tanker_bias;
272             mobile_name = _tanker_name;
273         }
274         mobile_valid = true;
275     }
276     else if ( _carrier_valid && !_tanker_valid ){
277         SG_LOG( SG_INSTR, SG_DEBUG, " select carrier  " );
278         mobile_bearing = carrier_bearing;
279         mobile_distance = carrier_distance;
280         mobile_elevation_ft = _carrier_elevation_ft;
281         mobile_range_nm = _carrier_range_nm;
282         mobile_bias = _carrier_bias;
283         mobile_name = _carrier_name;
284         mobile_valid = true;
285     }
286     else if ( !_carrier_valid && _tanker_valid ){
287         SG_LOG( SG_INSTR, SG_DEBUG, " select tanker  " );
288         mobile_bearing = tanker_bearing;
289         mobile_distance = tanker_distance;
290         mobile_elevation_ft = _tanker_elevation_ft;
291         mobile_range_nm = _tanker_range_nm;
292         mobile_bias = _tanker_bias;
293         mobile_name = _tanker_name;
294         mobile_valid = true;
295     }else{
296         mobile_valid = false;
297     }
298
299
300
301
302     //select the nearer
303     if ( mobile_distance <= distance && mobile_valid) {
304         SG_LOG( SG_INSTR, SG_DEBUG, "mobile_distance_m " << mobile_distance);
305         SG_LOG( SG_INSTR, SG_DEBUG, "distance_m " << distance);
306         bearing = mobile_bearing;
307         distance = mobile_distance;
308         _transmitter_elevation_ft = mobile_elevation_ft;
309         _transmitter_range_nm = mobile_range_nm;
310         _transmitter_bias = mobile_bias;
311         _transmitter_name = mobile_name;
312         _name_node->setStringValue(_transmitter_name.c_str());
313         _channel_node->setStringValue(_channel.c_str());
314     }
315
316     //// calculate some values for boresight display
317     double distance_nm = distance * SG_METER_TO_NM;
318
319     //// calculate look left/right to target, without yaw correction
320     // double horiz_offset = bearing - heading;
321     //
322     // if (horiz_offset > 180.0) horiz_offset -= 360.0;
323     // if (horiz_offset < -180.0) horiz_offset += 360.0;
324
325     //// now correct look left/right for yaw
326     // horiz_offset += yaw;
327
328     // use the bearing for plan position indicator display
329
330     double horiz_offset = bearing;
331
332     SG_LOG( SG_INSTR, SG_DEBUG, "distance_nm " << distance_nm  << " bearing "
333             << bearing << " horiz_offset " << horiz_offset);
334
335     // calculate values for radar display
336     double y_shift = distance_nm * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
337     double x_shift = distance_nm * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
338
339     SG_LOG( SG_INSTR, SG_DEBUG, "y_shift " << y_shift  << " x_shift " << x_shift);
340
341     double rotation = 0;
342
343     /*Point3D location =
344         sgGeodToCart(Point3D(longitude_rad, latitude_rad, altitude_m));
345     double distance_nm = _transmitter.distance3D(location) * SG_METER_TO_NM;*/
346
347     double range_nm = adjust_range(_transmitter_elevation_ft,
348                                    altitude_m * SG_METER_TO_FEET,
349                                    _transmitter_range_nm);
350
351     if (distance_nm <= range_nm) {
352         double speed_kt = (fabs(distance_nm - _last_distance_nm) *
353                            ((1 / delta_time_sec) * 3600.0));
354         _last_distance_nm = distance_nm;
355
356         _in_range_node->setBoolValue(true);
357         double tmp_dist = distance_nm - _transmitter_bias;
358         if ( tmp_dist < 0.0 ) {
359             tmp_dist = 0.0;
360         }
361         _distance_node->setDoubleValue( tmp_dist );
362         _speed_node->setDoubleValue(speed_kt);
363         _time_node->setDoubleValue(distance_nm/speed_kt*60.0);
364         _bearing_node->setDoubleValue(bearing);
365         _x_shift_node->setDoubleValue(x_shift);
366         _y_shift_node->setDoubleValue(y_shift);
367         _rotation_node->setDoubleValue(rotation);
368     } else {
369         _last_distance_nm = 0;
370         _in_range_node->setBoolValue(false);
371         _distance_node->setDoubleValue(0);
372         _speed_node->setDoubleValue(0);
373         _time_node->setDoubleValue(0);
374         _bearing_node->setDoubleValue(0);
375         _x_shift_node->setDoubleValue(0);
376         _y_shift_node->setDoubleValue(0);
377         _rotation_node->setDoubleValue(0);
378     }
379
380                                 // If we can't find a valid station set everything to zero
381     if (!_transmitter_valid && !mobile_valid ) {
382         _in_range_node->setBoolValue(false);
383         _distance_node->setDoubleValue(0);
384         _speed_node->setDoubleValue(0);
385         _time_node->setDoubleValue(0);
386         _bearing_node->setDoubleValue(0);
387         _x_shift_node->setDoubleValue(0);
388         _y_shift_node->setDoubleValue(0);
389         _rotation_node->setDoubleValue(0);
390         _transmitter_name = "";
391         _name_node->setStringValue(_transmitter_name.c_str());
392         _channel_node->setStringValue(_channel.c_str());
393         return;
394     }
395 } // end function update
396
397 void
398 TACAN::search (double frequency_mhz, double longitude_rad,
399                double latitude_rad, double altitude_m)
400 {
401     int number, i;
402
403     SG_LOG( SG_INSTR, SG_DEBUG, "tacan freq " << frequency_mhz );
404
405     // reset search time
406     _time_before_search_sec = 1.0;
407
408     //try any carriers first
409      FGNavRecord *carrier_tacan
410           = globals->get_carrierlist()->findStationByFreq( frequency_mhz );
411     _carrier_valid = (carrier_tacan != NULL);
412
413     if ( _carrier_valid ) {
414         SG_LOG( SG_INSTR, SG_DEBUG, "carrier transmitter valid " << _carrier_valid  );
415
416         string str1( carrier_tacan->get_name() );
417
418         SGPropertyNode * branch = fgGetNode("ai/models", true);
419         vector<SGPropertyNode_ptr> carrier = branch->getChildren("carrier");
420
421         number = carrier.size();
422
423         SG_LOG( SG_INSTR, SG_DEBUG, "carrier " << number );
424
425         for ( i = 0; i < number; ++i ) {
426             string str2 ( carrier[i]->getStringValue("name", ""));
427             SG_LOG( SG_INSTR, SG_DEBUG, "carrier name " << str2 );
428
429             SG_LOG( SG_INSTR, SG_DEBUG, "strings 1 " << str1 << " 2 " << str2 );
430             unsigned int loc1= str1.find( str2, 0 );
431             if ( loc1 != string::npos && str2 != "" ) {
432                 SG_LOG( SG_INSTR, SG_DEBUG, " string found" );
433                 _carrier_lat = carrier[i]->getDoubleValue("position/latitude-deg");
434                 _carrier_lon = carrier[i]->getDoubleValue("position/longitude-deg");
435                 _carrier_elevation_ft = carrier_tacan->get_elev_ft();
436                 _carrier_range_nm = carrier_tacan->get_range();
437                 _carrier_bias = carrier_tacan->get_multiuse();
438                 _carrier_name = carrier_tacan->get_name();
439                 _carrier_valid = 1;
440                 SG_LOG( SG_INSTR, SG_DEBUG, " carrier transmitter valid " << _carrier_valid );
441                 break;
442             } else {
443                 _carrier_valid = 0;
444                 SG_LOG( SG_INSTR, SG_DEBUG, " carrier transmitter invalid " << _carrier_valid );
445             }
446         }
447
448         SG_LOG( SG_INSTR, SG_DEBUG, "name " << _carrier_name);
449         SG_LOG( SG_INSTR, SG_DEBUG, "lat " << _carrier_lat << "lon " << _carrier_lon);
450         SG_LOG( SG_INSTR, SG_DEBUG, "elev " << _carrier_elevation_ft);
451
452     } else {
453         SG_LOG( SG_INSTR, SG_DEBUG, " carrier transmitter invalid " << _carrier_valid  );
454     }
455
456     //try any tankers second
457      FGNavRecord *tanker_tacan
458           = globals->get_carrierlist()->findStationByFreq( frequency_mhz );
459
460      _tanker_valid = (tanker_tacan != NULL);
461
462
463     if ( _tanker_valid ) {
464         SG_LOG( SG_INSTR, SG_DEBUG, "tanker transmitter valid start " << _tanker_valid  );
465
466         string str3( tanker_tacan->get_name() );
467
468         SGPropertyNode * branch = fgGetNode("ai/models", true);
469         vector<SGPropertyNode_ptr> tanker = branch->getChildren("aircraft");
470
471         number = tanker.size();
472
473         SG_LOG( SG_INSTR, SG_DEBUG, "tanker number " << number );
474
475         for ( i = 0; i < number; ++i ) {
476             string str4 ( tanker[i]->getStringValue("callsign", ""));
477             SG_LOG( SG_INSTR, SG_DEBUG, "tanker callsign " << str4 );
478
479             SG_LOG( SG_INSTR, SG_DEBUG, "strings 3 " << str3 << " 4 " << str4 );
480             unsigned int loc1= str3.find( str4, 0 );
481             if ( loc1 != string::npos && str4 != "" ) {
482                 SG_LOG( SG_INSTR, SG_DEBUG, " string found" );
483                 _tanker_lat = tanker[i]->getDoubleValue("position/latitude-deg");
484                 _tanker_lon = tanker[i]->getDoubleValue("position/longitude-deg");
485                 _tanker_elevation_ft = tanker[i]->getDoubleValue("position/altitude-ft");
486                 _tanker_range_nm = tanker_tacan->get_range();
487                 _tanker_bias = tanker_tacan->get_multiuse();
488                 _tanker_name = tanker_tacan->get_name();
489                 _tanker_valid = 1;
490                 SG_LOG( SG_INSTR, SG_DEBUG, " tanker transmitter valid " << _tanker_valid );
491                 break;
492             } else {
493                 _tanker_valid = 0;
494                 SG_LOG( SG_INSTR, SG_DEBUG, " tanker transmitter invalid " << _tanker_valid );
495             }
496         }
497
498         SG_LOG( SG_INSTR, SG_DEBUG, "tanker name " << _tanker_name);
499         SG_LOG( SG_INSTR, SG_DEBUG, "lat " << _tanker_lat << "lon " << _tanker_lon);
500         SG_LOG( SG_INSTR, SG_DEBUG, "elev " << _tanker_elevation_ft);
501         SG_LOG( SG_INSTR, SG_DEBUG, "range " << _tanker_range_nm);
502
503     } else {
504         SG_LOG( SG_INSTR, SG_DEBUG, " tanker transmitter invalid " << _tanker_valid  );
505     }
506
507     // try the TACAN/VORTAC list next
508     FGNavRecord *tacan
509         = globals->get_tacanlist()->findByFreq( frequency_mhz, longitude_rad,
510                                                 latitude_rad, altitude_m);
511
512     _transmitter_valid = (tacan != NULL);
513
514     if ( _transmitter_valid ) {
515         SG_LOG( SG_INSTR, SG_DEBUG, "transmitter valid " << _transmitter_valid  );
516
517         _transmitter_lat = tacan->get_lat();
518         _transmitter_lon = tacan->get_lon();
519         _transmitter_elevation_ft = tacan->get_elev_ft();
520         _transmitter_range_nm = tacan->get_range();
521         _transmitter_bias = tacan->get_multiuse();
522         _transmitter_name = tacan->get_name();
523         _name_node->setStringValue(_transmitter_name.c_str());
524
525         SG_LOG( SG_INSTR, SG_DEBUG, "name " << _transmitter_name);
526         SG_LOG( SG_INSTR, SG_DEBUG, "lat " << _transmitter_lat << "lon " << _transmitter_lon);
527         SG_LOG( SG_INSTR, SG_DEBUG, "elev " << _transmitter_elevation_ft);
528
529     } else {
530         SG_LOG( SG_INSTR, SG_DEBUG, "transmitter invalid " << _transmitter_valid  );
531     }
532 }
533
534 double
535 TACAN::searchChannel (const string& _channel){
536
537     double frequency_khz = 0;
538
539     FGTACANRecord *freq
540         = globals->get_channellist()->findByChannel( _channel );
541     double _freq_valid = (freq != NULL);
542     SG_LOG( SG_INSTR, SG_DEBUG, "freq valid " << _freq_valid  );
543     if ( _freq_valid ) {
544         frequency_khz = freq->get_freq();
545         SG_LOG( SG_INSTR, SG_DEBUG, "freq output " << frequency_khz  );
546         //check sanity
547         if (frequency_khz >=9620 && frequency_khz <= 12130)
548             return frequency_khz/100;
549     }
550     return frequency_khz = 0;
551 } // end TACAN::searchChannel
552
553 // end of TACAN.cxx