src/Instrumentation/dme.cxx

   1 // dme.cxx - distance-measuring equipment.
   2 // Written by David Megginson, started 2003.
   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
  17 #include "dme.hxx"
  18
  19
  20 /**
  21  * Adjust the range.
  22  *
  23  * Start by calculating the radar horizon based on the elevation
  24  * difference, then clamp to the maximum, then add a fudge for
  25  * borderline reception.
  26  */
  27 static double
  28 adjust_range (double transmitter_elevation_ft, double aircraft_altitude_ft,
  29               double max_range_nm)
  30 {
  31     double delta_elevation_ft =
  32         fabs(aircraft_altitude_ft - transmitter_elevation_ft);
  33     double range_nm = 1.23 * sqrt(delta_elevation_ft);
  34     if (range_nm > max_range_nm)
  35         range_nm = max_range_nm;
  36     else if (range_nm < 20.0)
  37         range_nm = 20.0;
  38     double rand = sg_random();
  39     return range_nm + (range_nm * rand * rand);
  40 }
  41
  42
  43 DME::DME ( SGPropertyNode *node )
  44     : _last_distance_nm(0),
  45       _last_frequency_mhz(-1),
  46       _time_before_search_sec(0),
  47       _transmitter_valid(false),
  48       _transmitter_elevation_ft(0),
  49       _transmitter_range_nm(0),
  50       _transmitter_bias(0.0),
  51       _name(node->getStringValue("name", "dme")),
  52       _num(node->getIntValue("number", 0))
  53 {
  54 }
  55
  56 DME::~DME ()
  57 {
  58 }
  59
  60 void
  61 DME::init ()
  62 {
  63     string branch;
  64     branch = "/instrumentation/" + _name;
  65
  66     SGPropertyNode *node = fgGetNode(branch.c_str(), _num, true );
  67
  68     _longitude_node = fgGetNode("/position/longitude-deg", true);
  69     _latitude_node = fgGetNode("/position/latitude-deg", true);
  70     _altitude_node = fgGetNode("/position/altitude-ft", true);
  71     _serviceable_node = node->getChild("serviceable", 0, true);
  72     _electrical_node = fgGetNode("/systems/electrical/outputs/dme", true);
  73     SGPropertyNode *fnode = node->getChild("frequencies", 0, true);
  74     _source_node = fnode->getChild("source", 0, true);
  75     _frequency_node = fnode->getChild("selected-mhz", 0, true);
  76     _in_range_node = node->getChild("in-range", 0, true);
  77     _distance_node = node->getChild("indicated-distance-nm", 0, true);
  78     _speed_node = node->getChild("indicated-ground-speed-kt", 0, true);
  79     _time_node = node->getChild("indicated-time-min", 0, true);
  80 }
  81
  82 void
  83 DME::update (double delta_time_sec)
  84 {
  85                                 // Figure out the source
  86     const char * source = _source_node->getStringValue();
  87     if (source[0] == '\0') {
  88         string branch;
  89         branch = "/instrumentation/" + _name + "/frequencies/selected-mhz";
  90         _source_node->setStringValue(branch.c_str());
  91         source = _source_node->getStringValue();
  92     }
  93                                 // Get the frequency
  94
  95     double frequency_mhz = fgGetDouble(source, 108.0);
  96     if (frequency_mhz != _last_frequency_mhz) {
  97         _time_before_search_sec = 0;
  98         _last_frequency_mhz = frequency_mhz;
  99     }
 100
 101                                 // Get the aircraft position
 102     double longitude_rad =
 103         _longitude_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 104     double latitude_rad =
 105         _latitude_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 106     double altitude_m =
 107         _altitude_node->getDoubleValue() * SG_FEET_TO_METER;
 108
 109                                 // On timeout, scan again
 110     _time_before_search_sec -= delta_time_sec;
 111     if (_time_before_search_sec < 0)
 112         search(frequency_mhz, longitude_rad,
 113                latitude_rad, altitude_m);
 114
 115                                 // If it's off, don't bother.
 116     if (!_serviceable_node->getBoolValue() ||
 117         !_electrical_node->getBoolValue() ||
 118         !_transmitter_valid) {
 119         _last_distance_nm = 0;
 120         _in_range_node->setBoolValue(false);
 121         _distance_node->setDoubleValue(0);
 122         _speed_node->setDoubleValue(0);
 123         _time_node->setDoubleValue(0);
 124         return;
 125     }
 126
 127                                 // Calculate the distance to the transmitter
 128     SGGeod geod = SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m);
 129     SGVec3d location = SGVec3d::fromGeod(geod);
 130
 131     double distance_nm = dist(_transmitter, location) * SG_METER_TO_NM;
 132
 133     double range_nm = adjust_range(_transmitter_elevation_ft,
 134                                    altitude_m * SG_METER_TO_FEET,
 135                                    _transmitter_range_nm);
 136
 137     if (distance_nm <= range_nm) {
 138         double speed_kt = (fabs(distance_nm - _last_distance_nm) *
 139                            ((1 / delta_time_sec) * 3600.0));
 140         _last_distance_nm = distance_nm;
 141
 142         _in_range_node->setBoolValue(true);
 143         double tmp_dist = distance_nm - _transmitter_bias;
 144         if ( tmp_dist < 0.0 ) {
 145             tmp_dist = 0.0;
 146         }
 147         _distance_node->setDoubleValue( tmp_dist );
 148         _speed_node->setDoubleValue(speed_kt);
 149         if (SGLimitsd::min() < fabs(speed_kt))
 150           _time_node->setDoubleValue(distance_nm/speed_kt*60.0);
 151
 152     } else {
 153         _last_distance_nm = 0;
 154         _in_range_node->setBoolValue(false);
 155         _distance_node->setDoubleValue(0);
 156         _speed_node->setDoubleValue(0);
 157         _time_node->setDoubleValue(0);
 158     }
 159 }
 160
 161 void
 162 DME::search (double frequency_mhz, double longitude_rad,
 163              double latitude_rad, double altitude_m)
 164 {
 165     // reset search time
 166     _time_before_search_sec = 1.0;
 167
 168     // try the ILS list first
 169
 170     FGNavRecord *dme = globals->get_dmelist()->findByFreq( frequency_mhz,
 171       SGGeod::fromRadM(longitude_rad, latitude_rad, altitude_m));
 172
 173     _transmitter_valid = (dme != NULL);
 174
 175     if ( _transmitter_valid ) {
 176         _transmitter = dme->cart();
 177         _transmitter_elevation_ft = dme->get_elev_ft();
 178         _transmitter_range_nm = dme->get_range();
 179         _transmitter_bias = dme->get_multiuse();
 180     }
 181 }
 182
 183 // end of dme.cxx