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 using std::vector;
  21 using std::string;
  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     _name(node->getStringValue("name", "tacan")),
  50     _num(node->getIntValue("number", 0)),
  51     _new_frequency(false),
  52     _channel("0000"),
  53     _last_distance_nm(0),
  54     _frequency_mhz(-1),
  55     _time_before_search_sec(0),
  56     _mobile_valid(false),
  57     _transmitter_valid(false),
  58     _transmitter_pos(SGGeod::fromDeg(0, 0)),
  59     _transmitter_range_nm(0),
  60     _transmitter_bias(0.0),
  61     _mobile_lat(0.0),
  62     _mobile_lon(0.0),
  63     _listener_active(0)
  64 {
  65 }
  66
  67 TACAN::~TACAN ()
  68 {
  69 }
  70
  71 void
  72 TACAN::init ()
  73 {
  74     string branch;
  75     branch = "/instrumentation/" + _name;
  76
  77     SGPropertyNode *node = fgGetNode(branch.c_str(), _num, true );
  78
  79     _serviceable_node = node->getChild("serviceable", 0, true);
  80     _ident_node = node->getChild("ident", 0, true);
  81
  82     SGPropertyNode *fnode = node->getChild("frequencies", 0, true);
  83     _frequency_node = fnode->getChild("selected-mhz", 0, true);
  84
  85     _channel_in0_node = fnode->getChild("selected-channel", 0, true);
  86     _channel_in1_node = fnode->getChild("selected-channel", 1, true);
  87     _channel_in2_node = fnode->getChild("selected-channel", 2, true);
  88     _channel_in3_node = fnode->getChild("selected-channel", 3, true);
  89     _channel_in4_node = fnode->getChild("selected-channel", 4, true);
  90
  91     _channel_in0_node->addChangeListener(this);
  92     _channel_in1_node->addChangeListener(this);
  93     _channel_in2_node->addChangeListener(this);
  94     _channel_in3_node->addChangeListener(this);
  95     _channel_in4_node->addChangeListener(this, true);
  96
  97     _in_range_node = node->getChild("in-range", 0, true);
  98     _distance_node = node->getChild("indicated-distance-nm", 0, true);
  99     _speed_node = node->getChild("indicated-ground-speed-kt", 0, true);
 100     _time_node = node->getChild("indicated-time-min", 0, true);
 101     _name_node = node->getChild("name", 0, true);
 102     _bearing_node = node->getChild("indicated-bearing-true-deg", 0, true);
 103
 104     SGPropertyNode *dnode = node->getChild("display", 0, true);
 105     _x_shift_node = dnode->getChild("x-shift", 0, true);
 106     _y_shift_node = dnode->getChild("y-shift", 0, true);
 107     _rotation_node = dnode->getChild("rotation", 0, true);
 108     _channel_node = dnode->getChild("channel", 0, true);
 109
 110     SGPropertyNode *cnode = fgGetNode("/ai/models/carrier", _num, false );
 111     _carrier_name_node = cnode ? cnode->getChild("name", 0, false) : 0;
 112
 113     SGPropertyNode *tnode = fgGetNode("/ai/models/aircraft", _num, false);
 114     _tanker_callsign_node = tnode ? tnode->getChild("callsign", 0, false) : 0;
 115
 116     SGPropertyNode *mnode = fgGetNode("/ai/models/multiplayer", _num, false);
 117     _mp_callsign_node = mnode ? mnode->getChild("callsign", 0, false) : 0;
 118
 119     _longitude_node = fgGetNode("/position/longitude-deg", true);
 120     _latitude_node = fgGetNode("/position/latitude-deg", true);
 121     _altitude_node = fgGetNode("/position/altitude-ft", true);
 122     _heading_node = fgGetNode("/orientation/heading-deg", true);
 123     _yaw_node = fgGetNode("/orientation/side-slip-deg", true);
 124     _electrical_node = fgGetNode("/systems/electrical/outputs/tacan", true);
 125 }
 126
 127 void
 128 TACAN::update (double delta_time_sec)
 129 {
 130     // don't do anything when paused
 131     if (delta_time_sec == 0) return;
 132
 133     if (!_serviceable_node->getBoolValue() || !_electrical_node->getBoolValue()) {
 134         _last_distance_nm = 0;
 135         _in_range_node->setBoolValue(false);
 136         _distance_node->setDoubleValue(0);
 137         _speed_node->setDoubleValue(0);
 138         _time_node->setDoubleValue(0);
 139         SG_LOG( SG_INSTR, SG_DEBUG, "skip tacan" );
 140         return;
 141     }
 142
 143                                 // Get the aircraft position
 144     double longitude_deg = _longitude_node->getDoubleValue();
 145     double latitude_deg  = _latitude_node->getDoubleValue();
 146     double altitude_m    = _altitude_node->getDoubleValue() * SG_FEET_TO_METER;
 147     double longitude_rad = longitude_deg * SGD_DEGREES_TO_RADIANS;
 148     double latitude_rad  = latitude_deg * SGD_DEGREES_TO_RADIANS;
 149
 150                                 // On timeout, scan again
 151     _time_before_search_sec -= delta_time_sec;
 152     if ((_time_before_search_sec < 0 || _new_frequency) && _frequency_mhz >= 0)
 153         search(_frequency_mhz, longitude_rad, latitude_rad, altitude_m);
 154
 155                                  // Calculate the distance to the transmitter
 156
 157     //calculate the bearing and range of the mobile from the aircraft
 158     double mobile_az2 = 0;
 159     double mobile_bearing = 0;
 160     double mobile_distance = 0;
 161
 162     SG_LOG( SG_INSTR, SG_DEBUG, "mobile_lat " << _mobile_lat);
 163     SG_LOG( SG_INSTR, SG_DEBUG, "mobile_lon " << _mobile_lon);
 164     SG_LOG( SG_INSTR, SG_DEBUG, "mobile_name " << _mobile_name);
 165     SG_LOG( SG_INSTR, SG_DEBUG, "mobile_valid " << _mobile_valid);
 166     geo_inverse_wgs_84(altitude_m,
 167                        latitude_deg,
 168                        longitude_deg,
 169                        _mobile_lat,
 170                        _mobile_lon,
 171                        &mobile_bearing, &mobile_az2, &mobile_distance);
 172
 173
 174     //calculate the bearing and range of the station from the aircraft
 175     double az2 = 0;
 176     double bearing = 0;
 177     double distance = 0;
 178
 179     SGGeod pos = SGGeod::fromDegM(longitude_deg, latitude_deg, altitude_m);
 180     geo_inverse_wgs_84(pos, _transmitter_pos,
 181                        &bearing, &az2, &distance);
 182
 183
 184     //select the nearer
 185     if ( mobile_distance <= distance && _mobile_valid) {
 186         SG_LOG( SG_INSTR, SG_DEBUG, "mobile_distance_m " << mobile_distance);
 187         SG_LOG( SG_INSTR, SG_DEBUG, "distance_m " << distance);
 188         bearing = mobile_bearing;
 189         distance = mobile_distance;
 190         _transmitter_pos.setElevationFt(_mobile_elevation_ft);
 191         _transmitter_range_nm = _mobile_range_nm;
 192         _transmitter_bias = _mobile_bias;
 193         _transmitter_name = _mobile_name;
 194         _name_node->setStringValue(_transmitter_name.c_str());
 195         _transmitter_ident = _mobile_ident;
 196         _ident_node->setStringValue(_transmitter_ident.c_str());
 197         _channel_node->setStringValue(_channel.c_str());
 198     }
 199
 200     //// calculate some values for boresight display
 201     double distance_nm = distance * SG_METER_TO_NM;
 202
 203     //// calculate look left/right to target, without yaw correction
 204     // double horiz_offset = bearing - heading;
 205     //
 206     // if (horiz_offset > 180.0) horiz_offset -= 360.0;
 207     // if (horiz_offset < -180.0) horiz_offset += 360.0;
 208
 209     //// now correct look left/right for yaw
 210     // horiz_offset += yaw;
 211
 212     // use the bearing for a plan position indicator display
 213
 214     double horiz_offset = bearing;
 215
 216     SG_LOG( SG_INSTR, SG_DEBUG, "distance_nm " << distance_nm << " bearing "
 217             << bearing << " horiz_offset " << horiz_offset);
 218
 219     // calculate values for radar display
 220     double y_shift = distance_nm * cos( horiz_offset * SG_DEGREES_TO_RADIANS);
 221     double x_shift = distance_nm * sin( horiz_offset * SG_DEGREES_TO_RADIANS);
 222
 223     SG_LOG( SG_INSTR, SG_DEBUG, "y_shift " << y_shift  << " x_shift " << x_shift);
 224
 225     double rotation = 0;
 226
 227     double range_nm = adjust_range(_transmitter_pos.getElevationFt(),
 228                                    altitude_m * SG_METER_TO_FEET,
 229                                    _transmitter_range_nm);
 230
 231     if (distance_nm <= range_nm) {
 232         double speed_kt = (fabs(distance_nm - _last_distance_nm) *
 233                            ((1 / delta_time_sec) * 3600.0));
 234         _last_distance_nm = distance_nm;
 235
 236         _in_range_node->setBoolValue(true);
 237         double tmp_dist = distance_nm - _transmitter_bias;
 238         if ( tmp_dist < 0.0 ) {
 239             tmp_dist = 0.0;
 240         }
 241         _distance_node->setDoubleValue( tmp_dist );
 242         _speed_node->setDoubleValue(speed_kt);
 243         _time_node->setDoubleValue(speed_kt > 0 ? (distance_nm/speed_kt*60.0) : 0);
 244         _bearing_node->setDoubleValue(bearing);
 245         _x_shift_node->setDoubleValue(x_shift);
 246         _y_shift_node->setDoubleValue(y_shift);
 247         _rotation_node->setDoubleValue(rotation);
 248     } else {
 249         _last_distance_nm = 0;
 250         _in_range_node->setBoolValue(false);
 251         _distance_node->setDoubleValue(0);
 252         _speed_node->setDoubleValue(0);
 253         _time_node->setDoubleValue(0);
 254         _bearing_node->setDoubleValue(0);
 255         _x_shift_node->setDoubleValue(0);
 256         _y_shift_node->setDoubleValue(0);
 257         _rotation_node->setDoubleValue(0);
 258     }
 259
 260                                 // If we can't find a valid station set everything to zero
 261     if (!_transmitter_valid && !_mobile_valid ) {
 262         _in_range_node->setBoolValue(false);
 263         _distance_node->setDoubleValue(0);
 264         _speed_node->setDoubleValue(0);
 265         _time_node->setDoubleValue(0);
 266         _bearing_node->setDoubleValue(0);
 267         _x_shift_node->setDoubleValue(0);
 268         _y_shift_node->setDoubleValue(0);
 269         _rotation_node->setDoubleValue(0);
 270         _transmitter_name = "";
 271         _name_node->setStringValue(_transmitter_name.c_str());
 272         _transmitter_ident = "";
 273         _ident_node->setStringValue(_transmitter_ident.c_str());
 274         _channel_node->setStringValue(_channel.c_str());
 275         return;
 276     }
 277 } // end function update
 278
 279 void
 280 TACAN::search (double frequency_mhz, double longitude_rad,
 281                double latitude_rad, double altitude_m)
 282 {
 283     int number, i;
 284     _mobile_valid = false;
 285
 286     SG_LOG( SG_INSTR, SG_DEBUG, "tacan freq " << frequency_mhz );
 287
 288     // reset search time
 289     _time_before_search_sec = 1.0;
 290
 291     //try any carriers first
 292     FGNavRecord *mobile_tacan
 293           = globals->get_carrierlist()->findStationByFreq( frequency_mhz );
 294     bool freq_valid = (mobile_tacan != NULL);
 295     SG_LOG( SG_INSTR, SG_DEBUG, "mobile freqency valid " << freq_valid );
 296
 297     if ( freq_valid ) {
 298
 299         string str1( mobile_tacan->name() );
 300
 301         SGPropertyNode * branch = fgGetNode("ai/models", true);
 302         vector<SGPropertyNode_ptr> carrier = branch->getChildren("carrier");
 303
 304         number = carrier.size();
 305
 306         SG_LOG( SG_INSTR, SG_DEBUG, "carrier " << number );
 307         for ( i = 0; i < number; ++i ) {
 308             string str2 ( carrier[i]->getStringValue("name", ""));
 309             SG_LOG( SG_INSTR, SG_DEBUG, "carrier name " << str2 );
 310
 311             SG_LOG( SG_INSTR, SG_DEBUG, "strings 1 " << str1 << " 2 " << str2 );
 312             string::size_type loc1= str1.find( str2, 0 );
 313             if ( loc1 != string::npos && str2 != "" ) {
 314                 SG_LOG( SG_INSTR, SG_DEBUG, " string found" );
 315                 _mobile_lat = carrier[i]->getDoubleValue("position/latitude-deg");
 316                 _mobile_lon = carrier[i]->getDoubleValue("position/longitude-deg");
 317                 _mobile_elevation_ft = mobile_tacan->get_elev_ft();
 318                 _mobile_range_nm = mobile_tacan->get_range();
 319                 _mobile_bias = mobile_tacan->get_multiuse();
 320                 _mobile_name = mobile_tacan->name();
 321                 _mobile_ident = mobile_tacan->get_trans_ident();
 322                 _mobile_valid = true;
 323                 SG_LOG( SG_INSTR, SG_DEBUG, " carrier transmitter valid " << _mobile_valid );
 324                 break;
 325             } else {
 326                 _mobile_valid = false;
 327                 SG_LOG( SG_INSTR, SG_DEBUG, " carrier transmitter invalid " << _mobile_valid );
 328             }
 329         }
 330
 331         //try any AI tankers second
 332
 333         if ( !_mobile_valid) {
 334             SG_LOG( SG_INSTR, SG_DEBUG, "tanker transmitter valid start " << _mobile_valid );
 335
 336         SGPropertyNode * branch = fgGetNode("ai/models", true);
 337         vector<SGPropertyNode_ptr> tanker = branch->getChildren("tanker");
 338
 339         number = tanker.size();
 340
 341         SG_LOG( SG_INSTR, SG_DEBUG, "tanker number " << number );
 342
 343         for ( i = 0; i < number; ++i ) {
 344             string str4 ( tanker[i]->getStringValue("callsign", ""));
 345             SG_LOG( SG_INSTR, SG_DEBUG, "tanker callsign " << str4 );
 346
 347             SG_LOG( SG_INSTR, SG_DEBUG, "strings 1 " << str1 << " 4 " << str4 );
 348             string::size_type loc1= str1.find( str4, 0 );
 349             if ( loc1 != string::npos && str4 != "" ) {
 350                 SG_LOG( SG_INSTR, SG_DEBUG, " string found" );
 351                 _mobile_lat = tanker[i]->getDoubleValue("position/latitude-deg");
 352                 _mobile_lon = tanker[i]->getDoubleValue("position/longitude-deg");
 353                 _mobile_elevation_ft = tanker[i]->getDoubleValue("position/altitude-ft");
 354                 _mobile_range_nm = mobile_tacan->get_range();
 355                 _mobile_bias = mobile_tacan->get_multiuse();
 356                 _mobile_name = mobile_tacan->name();
 357                 _mobile_ident = mobile_tacan->get_trans_ident();
 358                 _mobile_valid = true;
 359                 SG_LOG( SG_INSTR, SG_DEBUG, " tanker transmitter valid " << _mobile_valid );
 360                 break;
 361             } else {
 362                 _mobile_valid = false;
 363                 SG_LOG( SG_INSTR, SG_DEBUG, " tanker transmitter invalid " << _mobile_valid );
 364             }
 365         }
 366     }
 367
 368     //try any mp tankers third, if we haven't found the tanker in the ai aircraft
 369
 370     if ( !_mobile_valid ) {
 371         SG_LOG( SG_INSTR, SG_DEBUG, " mp tanker transmitter valid start " << _mobile_valid );
 372
 373         SGPropertyNode * branch = fgGetNode("ai/models", true);
 374         vector<SGPropertyNode_ptr> mp_tanker = branch->getChildren("multiplayer");
 375
 376         number = mp_tanker.size();
 377
 378         SG_LOG( SG_INSTR, SG_DEBUG, " mp tanker number " << number );
 379
 380         if ( number > 0 ) {       // don't do this if there are no MP aircraft
 381             for ( i = 0; i < number; ++i ) {
 382                 string str6 ( mp_tanker[i]->getStringValue("callsign", ""));
 383                 SG_LOG( SG_INSTR, SG_DEBUG, "mp tanker callsign " << str6 );
 384
 385                 SG_LOG( SG_INSTR, SG_DEBUG, "strings 1 " << str1 << " 5 " << str6 );
 386                 string::size_type loc1= str1.find( str6, 0 );
 387                 if ( loc1 != string::npos && str6 != "" ) {
 388                     SG_LOG( SG_INSTR, SG_DEBUG, " string found" );
 389                     _mobile_lat = mp_tanker[i]->getDoubleValue("position/latitude-deg");
 390                     _mobile_lon = mp_tanker[i]->getDoubleValue("position/longitude-deg");
 391                     _mobile_elevation_ft = mp_tanker[i]->getDoubleValue("position/altitude-ft");
 392                     _mobile_range_nm = mobile_tacan->get_range();
 393                     _mobile_bias = mobile_tacan->get_multiuse();
 394                     _mobile_name = mobile_tacan->name();
 395                     _mobile_ident = mobile_tacan->get_trans_ident();
 396                     _mobile_valid = true;
 397
 398                     SG_LOG( SG_INSTR, SG_DEBUG, " mp tanker transmitter valid " << _mobile_valid );
 399                     SG_LOG( SG_INSTR, SG_DEBUG, " mp tanker name " << _mobile_name);
 400                     SG_LOG( SG_INSTR, SG_DEBUG, " mp lat " << _mobile_lat << "lon " << _mobile_lon);
 401                     SG_LOG( SG_INSTR, SG_DEBUG, " mp elev " << _mobile_elevation_ft);
 402                     SG_LOG( SG_INSTR, SG_DEBUG, " mp range " << _mobile_range_nm);
 403                     break;
 404                 } else {
 405                     _mobile_valid = false;
 406                     SG_LOG( SG_INSTR, SG_DEBUG, " mp tanker transmitter invalid " << _mobile_valid );
 407                     }
 408                 }
 409             }
 410         }
 411     } else {
 412         _mobile_valid = false;
 413         SG_LOG( SG_INSTR, SG_DEBUG, " mobile transmitter invalid " << _mobile_valid );
 414     }
 415
 416     // try the TACAN/VORTAC list next
 417     FGNavRecord *tacan = globals->get_tacanlist()->findByFreq( frequency_mhz,
 418       SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m));
 419
 420     _transmitter_valid = (tacan != NULL);
 421
 422     if ( _transmitter_valid ) {
 423         SG_LOG( SG_INSTR, SG_DEBUG, "transmitter valid " << _transmitter_valid );
 424
 425         _transmitter_pos = tacan->geod();
 426         _transmitter_range_nm = tacan->get_range();
 427         _transmitter_bias = tacan->get_multiuse();
 428         _transmitter_name = tacan->name();
 429         _name_node->setStringValue(_transmitter_name.c_str());
 430         _transmitter_ident = tacan->get_trans_ident();
 431         _ident_node->setStringValue(_transmitter_ident.c_str());
 432
 433         SG_LOG( SG_INSTR, SG_DEBUG, "name " << _transmitter_name);
 434         SG_LOG( SG_INSTR, SG_DEBUG, _transmitter_pos);
 435
 436     } else {
 437         SG_LOG( SG_INSTR, SG_DEBUG, "transmitter invalid " << _transmitter_valid );
 438     }
 439 }
 440
 441 double
 442 TACAN::searchChannel (const string& channel)
 443 {
 444     double frequency_khz = 0;
 445
 446     FGTACANRecord *freq
 447         = globals->get_channellist()->findByChannel( channel );
 448     bool _freq_valid = (freq != NULL);
 449     SG_LOG( SG_INSTR, SG_DEBUG, "freq valid " << _freq_valid );
 450     if ( _freq_valid ) {
 451         frequency_khz = freq->get_freq();
 452         SG_LOG( SG_INSTR, SG_DEBUG, "freq output " << frequency_khz );
 453         //check sanity
 454         if (frequency_khz >= 9620 && frequency_khz <= 121300)
 455             return frequency_khz/100;
 456     }
 457     return frequency_khz = 0;
 458 } // end TACAN::searchChannel
 459
 460 /*
 461  * Listener callback. Maintains channel input properties,
 462  * searches new channel frequency, updates _channel and
 463  * _frequency and sets boolean _new_frequency appropriately.
 464  */
 465 void
 466 TACAN::valueChanged(SGPropertyNode *prop)
 467 {
 468     if (_listener_active)
 469         return;
 470     _listener_active++;
 471
 472     int index = prop->getIndex();
 473     string channel = _channel;
 474
 475     if (index) {  // channel digit or X/Y input
 476         int c;
 477         if (isdigit(c = _channel_in1_node->getStringValue()[0]))
 478             channel[0] = c;
 479         if (isdigit(c = _channel_in2_node->getStringValue()[0]))
 480             channel[1] = c;
 481         if (isdigit(c = _channel_in3_node->getStringValue()[0]))
 482             channel[2] = c;
 483         c = _channel_in4_node->getStringValue()[0];
 484         if (c == 'X' || c == 'Y')
 485             channel[3] = c;
 486
 487     } else {      // channel number input
 488         unsigned int f = prop->getIntValue();
 489         if (f >= 1 && f <= 126) {
 490             channel[0] = '0' + (f / 100) % 10;
 491             channel[1] = '0' + (f / 10) % 10;
 492             channel[2] = '0' + f % 10;
 493         }
 494     }
 495
 496     if (channel != _channel) {
 497         SG_LOG(SG_INSTR, SG_DEBUG, "new channel " << channel);
 498
 499         // write back result
 500         _channel_in0_node->setIntValue((channel[0] - '0') * 100
 501                 + (channel[1] - '0') * 10 + (channel[2] - '0'));
 502         char s[2] = "0";
 503         s[0] = channel[0], _channel_in1_node->setStringValue(s);
 504         s[0] = channel[1], _channel_in2_node->setStringValue(s);
 505         s[0] = channel[2], _channel_in3_node->setStringValue(s);
 506         s[0] = channel[3], _channel_in4_node->setStringValue(s);
 507
 508         // search channel frequency
 509         double freq = searchChannel(channel);
 510         if (freq != _frequency_mhz) {
 511             SG_LOG(SG_INSTR, SG_DEBUG, "new frequency " << freq);
 512             _frequency_node->setDoubleValue(freq);
 513             _frequency_mhz = freq;
 514             _new_frequency = true;
 515         }
 516
 517         _channel = channel;
 518         _time_before_search_sec = 0;
 519     }
 520
 521     _listener_active--;
 522 }
 523
 524 // end of TACAN.cxx