src/ATC/commlist.cxx

   1 // commlist.cxx -- comm frequency lookup class
   2 //
   3 // Written by David Luff and Alexander Kappes, started Jan 2003.
   4 // Based on navlist.cxx by Curtis Olson, started April 2000.
   5 //
   6 // Copyright (C) 2000  Curtis L. Olson - curt@flightgear.org
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include <simgear/debug/logstream.hxx>
  28 #include <simgear/misc/sgstream.hxx>
  29 #include <simgear/math/sg_geodesy.hxx>
  30 #include <simgear/math/sg_random.h>
  31 #include <simgear/bucket/newbucket.hxx>
  32 #include <Airports/simple.hxx>
  33
  34 #include "commlist.hxx"
  35 //#include "atislist.hxx"
  36 #include "ATCutils.hxx"
  37
  38
  39 FGCommList *current_commlist;
  40
  41
  42 // Constructor
  43 FGCommList::FGCommList( void ) {
  44 }
  45
  46
  47 // Destructor
  48 FGCommList::~FGCommList( void ) {
  49 }
  50
  51
  52 // load the navaids and build the map
  53 bool FGCommList::init( SGPath path ) {
  54
  55         SGPath temp = path;
  56     commlist_freq.erase(commlist_freq.begin(), commlist_freq.end());
  57         commlist_bck.erase(commlist_bck.begin(), commlist_bck.end());
  58     temp.append( "ATC/default.atis" );
  59         LoadComms(temp);
  60         temp = path;
  61         temp.append( "ATC/default.tower" );
  62         LoadComms(temp);
  63         temp = path;
  64         temp.append( "ATC/default.approach" );
  65         LoadComms(temp);
  66         return true;
  67 }
  68
  69
  70 bool FGCommList::LoadComms(SGPath path) {
  71
  72     sg_gzifstream fin( path.str() );
  73     if ( !fin.is_open() ) {
  74         SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << path.str() );
  75         exit(-1);
  76     }
  77
  78     // read in each line of the file
  79     fin >> skipcomment;
  80
  81 #ifdef __MWERKS__
  82     char c = 0;
  83     while ( fin.get(c) && c != '\0' ) {
  84         fin.putback(c);
  85 #else
  86     while ( !fin.eof() ) {
  87 #endif
  88         ATCData a;
  89                 fin >> a;
  90                 if(a.type == INVALID) {
  91                         SG_LOG(SG_GENERAL, SG_ALERT, "WARNING - INVALID type found in " << path.str() << '\n');
  92                 } else {
  93                         // Push all stations onto frequency map
  94                         commlist_freq[a.freq].push_back(a);
  95
  96                         // Push non-atis stations onto bucket map as well
  97                         if(a.type != ATIS) {
  98                                 // get bucket number
  99                                 SGBucket bucket(a.lon, a.lat);
 100                                 int bucknum = bucket.gen_index();
 101                                 commlist_bck[bucknum].push_back(a);
 102                         }
 103                 }
 104
 105                 fin >> skipcomment;
 106         }
 107
 108         fin.close();
 109         return true;
 110 }
 111
 112
 113 // query the database for the specified frequency, lon and lat are in
 114 // degrees, elev is in meters
 115 // If no atc_type is specified, it returns true if any non-invalid type is found
 116 // If atc_type is specifed, returns true only if the specified type is found
 117 bool FGCommList::FindByFreq( double lon, double lat, double elev, double freq,
 118                                                 ATCData* ad, atc_type tp )
 119 {
 120         lon *= SGD_DEGREES_TO_RADIANS;
 121         lat *= SGD_DEGREES_TO_RADIANS;
 122
 123         comm_list_type stations = commlist_freq[(int)(freq*100.0 + 0.5)];
 124         comm_list_iterator current = stations.begin();
 125         comm_list_iterator last = stations.end();
 126
 127         // double az1, az2, s;
 128         Point3D aircraft = sgGeodToCart( Point3D(lon, lat, elev) );
 129         Point3D station;
 130         double d;
 131         // TODO - at the moment this loop returns the first match found in range
 132         // We want to return the closest match in the event of a frequency conflict
 133         for ( ; current != last ; ++current ) {
 134                 //cout << "testing " << current->get_ident() << endl;
 135                 station = Point3D(current->x, current->y, current->z);
 136                 //cout << "aircraft = " << aircraft << endl;
 137                 //cout << "station = " << station << endl;
 138
 139                 d = aircraft.distance3Dsquared( station );
 140
 141                 //cout << "  dist = " << sqrt(d)
 142                 //     << "  range = " << current->get_range() * SG_NM_TO_METER << endl;
 143
 144                 // match up to twice the published range so we can model
 145                 // reduced signal strength
 146                 if ( d < (2 * current->range * SG_NM_TO_METER
 147                 * 2 * current->range * SG_NM_TO_METER ) ) {
 148                         //cout << "matched = " << current->get_ident() << endl;
 149                         if((tp == INVALID) || (tp == (*current).type)) {
 150                                 *ad = *current;
 151                                 return true;
 152                         }
 153                 }
 154         }
 155
 156         return false;
 157 }
 158
 159 int FGCommList::FindByPos(double lon, double lat, double elev, comm_list_type* stations, atc_type tp)
 160 {
 161         // number of relevant stations found within range
 162         int found = 0;
 163         stations->erase(stations->begin(), stations->end());
 164
 165         // get bucket number for plane position
 166         SGBucket buck(lon, lat);
 167
 168         // get neigboring buckets
 169         int max_range = 100;
 170         int bx = (int)( max_range*SG_NM_TO_METER / buck.get_width_m() / 2);
 171         int by = (int)( max_range*SG_NM_TO_METER / buck.get_height_m() / 2 );
 172
 173         // loop over bucket range
 174         for ( int i=-bx; i<bx; i++) {
 175                 for ( int j=-by; j<by; j++) {
 176                         buck = sgBucketOffset(lon, lat, i, j);
 177                         long int bucket = buck.gen_index();
 178                         comm_list_type Fstations = commlist_bck[bucket];
 179                         comm_list_iterator current = Fstations.begin();
 180                         comm_list_iterator last = Fstations.end();
 181
 182                         double rlon = lon * SGD_DEGREES_TO_RADIANS;
 183                         double rlat = lat * SGD_DEGREES_TO_RADIANS;
 184
 185                         // double az1, az2, s;
 186                         Point3D aircraft = sgGeodToCart( Point3D(rlon, rlat, elev) );
 187                         Point3D station;
 188                         double d;
 189                         for(; current != last; ++current) {
 190                                 if((current->type == tp) || (tp == INVALID)) {
 191                                         station = Point3D(current->x, current->y, current->z);
 192                                         d = aircraft.distance3Dsquared( station );
 193                                         if ( d < (current->range * SG_NM_TO_METER
 194                                         * current->range * SG_NM_TO_METER ) ) {
 195                                                 stations->push_back(*current);
 196                                                 ++found;
 197                                         }
 198                                 }
 199                         }
 200                 }
 201         }
 202         return found;
 203 }
 204
 205
 206 // Find by Airport code.
 207 // This is basically a wrapper for a call to the airport database to get the airport
 208 // position followed by a call to FindByPos(...)
 209 bool FGCommList::FindByCode( string ICAO, ATCData& ad, atc_type tp ) {
 210     FGAirport a;
 211     if ( dclFindAirportID( ICAO, &a ) ) {
 212                 comm_list_type stations;
 213                 int found = FindByPos(a.longitude, a.latitude, a.elevation, &stations, tp);
 214                 if(found) {
 215                         comm_list_iterator itr = stations.begin();
 216                         while(itr != stations.end()) {
 217                                 if(((*itr).ident == ICAO) && ((*itr).type == tp)) {
 218                                         ad = *itr;
 219                                         return true;
 220                                 }
 221                         }
 222                 }
 223     } else {
 224         return false;
 225     }
 226         return false;
 227 }
 228
 229
 230 // TODO - this function should move somewhere else eventually!
 231 // Return an appropriate call-sign for an ATIS transmission.
 232 int FGCommList::GetCallSign( string apt_id, int hours, int mins )
 233 {
 234         atis_transmission_type tran;
 235
 236         if(atislog.find(apt_id) == atislog.end()) {
 237                 // This station has not transmitted yet - return a random identifier
 238                 // and add the transmission to the log
 239                 tran.hours = hours;
 240                 tran.mins = mins;
 241                 sg_srandom_time();
 242                 tran.callsign = int(sg_random() * 25) + 1;      // This *should* give a random int between 1 and 26
 243                 //atislog[apt_id].push_back(tran);
 244                 atislog[apt_id] = tran;
 245         } else {
 246                 // This station has transmitted - calculate the appropriate identifier
 247                 // and add the transmission to the log if it has changed
 248                 tran = atislog[apt_id];
 249                 // This next bit assumes that no-one comes back to the same ATIS station
 250                 // after running FlightGear for more than 24 hours !!
 251                 if((tran.hours == hours) && (tran.mins == mins)) {
 252                         return(tran.callsign);
 253                 } else {
 254                         if(tran.hours == hours) {
 255                                 // The minutes must have changed
 256                                 tran.mins = mins;
 257                                 tran.callsign++;
 258                         } else {
 259                                 if(hours < tran.hours) {
 260                                         hours += 24;
 261                                 }
 262                                 tran.callsign += (hours - tran.hours);
 263                                 if(mins != 0) {
 264                                         // Assume transmissions were made on every hour
 265                                         tran.callsign++;
 266                                 }
 267                                 tran.hours = hours;
 268                                 tran.mins = mins;
 269                         }
 270                         // Wrap if we've exceeded Zulu
 271                         if(tran.callsign > 26) {
 272                                 tran.callsign -= 26;
 273                         }
 274                         // And write the new transmission to the log
 275                         atislog[apt_id] = tran;
 276                 }
 277         }
 278         return(tran.callsign);
 279 }