src/Airports/apt_loader.cxx

   1 // apt_loader.cxx -- a front end loader of the apt.dat file.  This loader
   2 //                   populates the runway and basic classes.
   3 //
   4 // Written by Curtis Olson, started August 2000.
   5 //
   6 // Copyright (C) 2000  Curtis L. Olson  - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21 //
  22 // $Id$
  23
  24
  25 #ifdef HAVE_CONFIG_H
  26 #  include <config.h>
  27 #endif
  28
  29 #include "apt_loader.hxx"
  30
  31 #include <simgear/compiler.h>
  32
  33 #include <stdlib.h> // atof(), atoi()
  34 #include <string.h> // memchr()
  35 #include <ctype.h> // isspace()
  36
  37 #include <simgear/constants.h>
  38 #include <simgear/debug/logstream.hxx>
  39 #include <simgear/misc/sgstream.hxx>
  40 #include <simgear/misc/strutils.hxx>
  41 #include <simgear/structure/exception.hxx>
  42 #include <simgear/misc/sg_path.hxx>
  43
  44 #include <string>
  45
  46 #include "simple.hxx"
  47 #include "runways.hxx"
  48 #include "pavement.hxx"
  49 #include <Navaids/NavDataCache.hxx>
  50 #include <ATC/CommStation.hxx>
  51
  52 #include <iostream>
  53
  54 using namespace std;
  55
  56 typedef SGSharedPtr<FGPavement> FGPavementPtr;
  57
  58 static FGPositioned::Type fptypeFromRobinType(int aType)
  59 {
  60   switch (aType) {
  61   case 1: return FGPositioned::AIRPORT;
  62   case 16: return FGPositioned::SEAPORT;
  63   case 17: return FGPositioned::HELIPORT;
  64   default:
  65     SG_LOG(SG_GENERAL, SG_ALERT, "unsupported type:" << aType);
  66     throw sg_range_exception("Unsupported airport type", "fptypeFromRobinType");
  67   }
  68 }
  69
  70
  71 namespace flightgear
  72 {
  73
  74 class APTLoader
  75 {
  76 public:
  77
  78   APTLoader()
  79   :  last_apt_id(""),
  80      last_apt_elev(0.0),
  81      last_apt_info("")
  82   {
  83     currentAirportID = 0;
  84     cache = NavDataCache::instance();
  85   }
  86
  87   void parseAPT(const SGPath &aptdb_file)
  88   {
  89     sg_gzifstream in( aptdb_file.str() );
  90
  91     if ( !in.is_open() ) {
  92         SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << aptdb_file );
  93         exit(-1);
  94     }
  95
  96     string line;
  97     char tmp[2049];
  98     tmp[2048] = 0;
  99
 100     unsigned int line_id = 0;
 101     unsigned int line_num = 0;
 102
 103     while ( ! in.eof() ) {
 104       in.getline(tmp, 2048);
 105       line = tmp; // string copy, ack
 106       line_num++;
 107
 108       if ( !line.size() || isspace(tmp[0])) {
 109         continue;
 110       }
 111
 112       if (line.size() >= 3) {
 113           char *p = (char *)memchr(tmp, ' ', 3);
 114           if ( p )
 115               *p = 0;
 116       }
 117
 118       line_id = atoi(tmp);
 119       if ( tmp[0] == 'I' ) {
 120         // First line, indicates IBM (i.e. DOS line endings I
 121         // believe.)
 122
 123         // move past this line and read and discard the next line
 124         // which is the version and copyright information
 125         in.getline(tmp, 2048);
 126         // vector<string> vers_token = simgear::strutils::split( tmp );
 127         if ( strlen(tmp) > 4 ) {
 128            char *p = (char *)memchr(tmp, ' ', 4);
 129            if ( p )
 130               *p = 0;
 131         }
 132         SG_LOG( SG_GENERAL, SG_INFO, "Data file version = " << tmp );
 133       } else if ( line_id == 1 /* Airport */ ||
 134                     line_id == 16 /* Seaplane base */ ||
 135                     line_id == 17 /* Heliport */ ) {
 136         parseAirportLine(simgear::strutils::split(line));
 137       } else if ( line_id == 10 ) { // Runway v810
 138         parseRunwayLine810(simgear::strutils::split(line));
 139       } else if ( line_id == 100 ) { // Runway v850
 140         parseRunwayLine850(simgear::strutils::split(line));
 141       } else if ( line_id == 101 ) { // Water Runway v850
 142         parseWaterRunwayLine850(simgear::strutils::split(line));
 143       } else if ( line_id == 102 ) { // Helipad v850
 144         parseHelipadLine850(simgear::strutils::split(line));
 145       } else if ( line_id == 18 ) {
 146             // beacon entry (ignore)
 147       } else if ( line_id == 14 ) {
 148         // control tower entry
 149         vector<string> token(simgear::strutils::split(line));
 150
 151         double lat = atof( token[1].c_str() );
 152         double lon = atof( token[2].c_str() );
 153         double elev = atof( token[3].c_str() );
 154         tower = SGGeod::fromDegFt(lon, lat, elev + last_apt_elev);
 155         got_tower = true;
 156
 157         cache->insertTower(currentAirportID, tower);
 158       } else if ( line_id == 19 ) {
 159           // windsock entry (ignore)
 160       } else if ( line_id == 20 ) {
 161           // Taxiway sign (ignore)
 162       } else if ( line_id == 21 ) {
 163           // lighting objects (ignore)
 164       } else if ( line_id == 15 ) {
 165           // custom startup locations (ignore)
 166       } else if ( line_id == 0 ) {
 167           // ??
 168       } else if ( line_id >= 50 && line_id <= 56) {
 169         parseCommLine(line_id, simgear::strutils::split(line));
 170       } else if ( line_id == 110 ) {
 171         pavement = true;
 172         parsePavementLine850(simgear::strutils::split(line, 0, 4));
 173       } else if ( line_id >= 111 && line_id <= 114 ) {
 174         if ( pavement )
 175           parsePavementNodeLine850(line_id, simgear::strutils::split(line));
 176       } else if ( line_id >= 115 && line_id <= 116 ) {
 177           // other pavement nodes (ignore)
 178       } else if ( line_id == 120 ) {
 179         pavement = false;
 180       } else if ( line_id == 130 ) {
 181         pavement = false;
 182       } else if ( line_id >= 1000 ) {
 183           // airport traffic flow (ignore)
 184       } else if ( line_id == 99 ) {
 185           SG_LOG( SG_GENERAL, SG_DEBUG, "End of file reached" );
 186       } else {
 187           SG_LOG( SG_GENERAL, SG_ALERT,
 188                   "Unknown line(#" << line_num << ") in apt.dat file: " << line );
 189           exit( -1 );
 190       }
 191     }
 192
 193     finishAirport();
 194   }
 195
 196 private:
 197   vector<string> token;
 198   double rwy_lat_accum;
 199   double rwy_lon_accum;
 200   double last_rwy_heading;
 201   int rwy_count;
 202   bool got_tower;
 203   string last_apt_id;
 204   double last_apt_elev;
 205   SGGeod tower;
 206   string last_apt_info;
 207   string pavement_ident;
 208   bool pavement;
 209
 210   //vector<FGRunwayPtr> runways;
 211   //vector<FGTaxiwayPtr> taxiways;
 212   vector<FGPavementPtr> pavements;
 213
 214   NavDataCache* cache;
 215   PositionedID currentAirportID;
 216
 217   void finishAirport()
 218   {
 219     if (currentAirportID == 0) {
 220       return;
 221     }
 222
 223     if (!rwy_count) {
 224       currentAirportID = 0;
 225       SG_LOG(SG_GENERAL, SG_ALERT, "ERROR: No runways for " << last_apt_id
 226               << ", skipping." );
 227       return;
 228     }
 229
 230     double lat = rwy_lat_accum / (double)rwy_count;
 231     double lon = rwy_lon_accum / (double)rwy_count;
 232
 233     if (!got_tower) {
 234       // tower height hard coded for now...
 235       const float tower_height = 50.0f;
 236       // make a little off the heading for 1 runway airports...
 237       float fudge_lon = fabs(sin(last_rwy_heading * SGD_DEGREES_TO_RADIANS)) * .003f;
 238       float fudge_lat = .003f - fudge_lon;
 239       tower = SGGeod::fromDegFt(lon + fudge_lon, lat + fudge_lat, last_apt_elev + tower_height);
 240
 241       cache->insertTower(currentAirportID, tower);
 242     }
 243
 244     SGGeod pos(SGGeod::fromDegFt(lon, lat, last_apt_elev));
 245     cache->updatePosition(currentAirportID, pos);
 246
 247     currentAirportID = 0;
 248   }
 249
 250   void parseAirportLine(const vector<string>& token)
 251   {
 252     const string& id(token[4]);
 253     double elev = atof( token[1].c_str() );
 254
 255   // finish the previous airport
 256     finishAirport();
 257
 258     last_apt_elev = elev;
 259     got_tower = false;
 260
 261     string name;
 262     // build the name
 263     for ( unsigned int i = 5; i < token.size() - 1; ++i ) {
 264         name += token[i] + " ";
 265     }
 266     name += token[token.size() - 1];
 267
 268     // clear runway list for start of next airport
 269     rwy_lon_accum = 0.0;
 270     rwy_lat_accum = 0.0;
 271     rwy_count = 0;
 272
 273     int robinType = atoi(token[0].c_str());
 274     currentAirportID = cache->insertAirport(fptypeFromRobinType(robinType), id, name);
 275   }
 276
 277   void parseRunwayLine810(const vector<string>& token)
 278   {
 279     double lat = atof( token[1].c_str() );
 280     double lon = atof( token[2].c_str() );
 281     rwy_lat_accum += lat;
 282     rwy_lon_accum += lon;
 283     rwy_count++;
 284
 285     const string& rwy_no(token[3]);
 286
 287     double heading = atof( token[4].c_str() );
 288     double length = atoi( token[5].c_str() );
 289     double width = atoi( token[8].c_str() );
 290
 291     last_rwy_heading = heading;
 292
 293     int surface_code = atoi( token[10].c_str() );
 294     SGGeod pos(SGGeod::fromDegFt(lon, lat, last_apt_elev));
 295
 296     if (rwy_no[0] == 'x') {
 297       cache->insertRunway(FGPositioned::TAXIWAY,rwy_no, pos, currentAirportID,
 298                           heading, length, width, 0, 0, surface_code);
 299     } else {
 300       // (pair of) runways
 301       string rwy_displ_threshold = token[6];
 302       vector<string> displ
 303           = simgear::strutils::split( rwy_displ_threshold, "." );
 304       double displ_thresh1 = atof( displ[0].c_str() );
 305       double displ_thresh2 = atof( displ[1].c_str() );
 306
 307       string rwy_stopway = token[7];
 308       vector<string> stop
 309           = simgear::strutils::split( rwy_stopway, "." );
 310       double stopway1 = atof( stop[0].c_str() );
 311       double stopway2 = atof( stop[1].c_str() );
 312
 313       PositionedID rwy = cache->insertRunway(FGPositioned::RUNWAY, rwy_no, pos,
 314                                              currentAirportID, heading, length,
 315                                              width, displ_thresh1, stopway1,
 316                                              surface_code);
 317
 318       PositionedID reciprocal = cache->insertRunway(FGPositioned::RUNWAY,
 319                                               FGRunway::reverseIdent(rwy_no), pos,
 320                                              currentAirportID, heading + 180.0, length,
 321                                              width, displ_thresh2, stopway2,
 322                                              surface_code);
 323
 324       cache->setRunwayReciprocal(rwy, reciprocal);
 325     }
 326   }
 327
 328   void parseRunwayLine850(const vector<string>& token)
 329   {
 330     double width = atof( token[1].c_str() ) * SG_METER_TO_FEET;
 331     int surface_code = atoi( token[2].c_str() );
 332
 333     double lat_1 = atof( token[9].c_str() );
 334     double lon_1 = atof( token[10].c_str() );
 335     SGGeod pos_1(SGGeod::fromDegFt(lon_1, lat_1, 0.0));
 336     rwy_lat_accum += lat_1;
 337     rwy_lon_accum += lon_1;
 338     rwy_count++;
 339
 340     double lat_2 = atof( token[18].c_str() );
 341     double lon_2 = atof( token[19].c_str() );
 342     SGGeod pos_2(SGGeod::fromDegFt(lon_2, lat_2, 0.0));
 343     rwy_lat_accum += lat_2;
 344     rwy_lon_accum += lon_2;
 345     rwy_count++;
 346
 347     double length, heading_1, heading_2, dummy;
 348     SGGeodesy::inverse( pos_1, pos_2, heading_1, heading_2, length );
 349     SGGeod pos;
 350     SGGeodesy::direct( pos_1, heading_1, length / 2.0, pos, dummy );
 351     length *= SG_METER_TO_FEET;
 352
 353     last_rwy_heading = heading_1;
 354
 355     const string& rwy_no_1(token[8]);
 356     const string& rwy_no_2(token[17]);
 357     if ( rwy_no_1.size() == 0 || rwy_no_2.size() == 0 )
 358         return;
 359
 360     double displ_thresh1 = atof( token[11].c_str() );
 361     double displ_thresh2 = atof( token[20].c_str() );
 362
 363     double stopway1 = atof( token[12].c_str() );
 364     double stopway2 = atof( token[21].c_str() );
 365
 366     PositionedID rwy = cache->insertRunway(FGPositioned::RUNWAY, rwy_no_1, pos,
 367                                            currentAirportID, heading_1, length,
 368                                            width, displ_thresh1, stopway1,
 369                                            surface_code);
 370
 371     PositionedID reciprocal = cache->insertRunway(FGPositioned::RUNWAY,
 372                                                   rwy_no_2, pos,
 373                                                   currentAirportID, heading_2, length,
 374                                                   width, displ_thresh2, stopway2,
 375                                                   surface_code);
 376
 377     cache->setRunwayReciprocal(rwy, reciprocal);
 378   }
 379
 380   void parseWaterRunwayLine850(const vector<string>& token)
 381   {
 382     double width = atof( token[1].c_str() ) * SG_METER_TO_FEET;
 383
 384     double lat_1 = atof( token[4].c_str() );
 385     double lon_1 = atof( token[5].c_str() );
 386     SGGeod pos_1(SGGeod::fromDegFt(lon_1, lat_1, 0.0));
 387     rwy_lat_accum += lat_1;
 388     rwy_lon_accum += lon_1;
 389     rwy_count++;
 390
 391     double lat_2 = atof( token[7].c_str() );
 392     double lon_2 = atof( token[8].c_str() );
 393     SGGeod pos_2(SGGeod::fromDegFt(lon_2, lat_2, 0.0));
 394     rwy_lat_accum += lat_2;
 395     rwy_lon_accum += lon_2;
 396     rwy_count++;
 397
 398     double length, heading_1, heading_2, dummy;
 399     SGGeodesy::inverse( pos_1, pos_2, heading_1, heading_2, length );
 400     SGGeod pos;
 401     SGGeodesy::direct( pos_1, heading_1, length / 2.0, pos, dummy );
 402
 403     last_rwy_heading = heading_1;
 404
 405     const string& rwy_no_1(token[3]);
 406     const string& rwy_no_2(token[6]);
 407
 408     PositionedID rwy = cache->insertRunway(FGPositioned::RUNWAY, rwy_no_1, pos,
 409                                            currentAirportID, heading_1, length,
 410                                            width, 0.0, 0.0, 13);
 411
 412     PositionedID reciprocal = cache->insertRunway(FGPositioned::RUNWAY,
 413                                                   rwy_no_2, pos,
 414                                                   currentAirportID, heading_2, length,
 415                                                   width, 0.0, 0.0, 13);
 416
 417     cache->setRunwayReciprocal(rwy, reciprocal);
 418   }
 419
 420   void parseHelipadLine850(const vector<string>& token)
 421   {
 422     double length = atof( token[5].c_str() ) * SG_METER_TO_FEET;
 423     double width = atof( token[6].c_str() ) * SG_METER_TO_FEET;
 424
 425     double lat = atof( token[2].c_str() );
 426     double lon = atof( token[3].c_str() );
 427     SGGeod pos(SGGeod::fromDegFt(lon, lat, 0.0));
 428     rwy_lat_accum += lat;
 429     rwy_lon_accum += lon;
 430     rwy_count++;
 431
 432     double heading = atof( token[4].c_str() );
 433
 434     last_rwy_heading = heading;
 435
 436     const string& rwy_no(token[1]);
 437     int surface_code = atoi( token[7].c_str() );
 438
 439     cache->insertRunway(FGPositioned::RUNWAY, rwy_no, pos,
 440                         currentAirportID, heading, length,
 441                         width, 0.0, 0.0, surface_code);
 442   }
 443
 444   void parsePavementLine850(const vector<string>& token)
 445   {
 446     if ( token.size() >= 5 ) {
 447       pavement_ident = token[4];
 448       if ( !pavement_ident.empty() && pavement_ident[pavement_ident.size()-1] == '\r' )
 449         pavement_ident.erase( pavement_ident.size()-1 );
 450     } else {
 451       pavement_ident = "xx";
 452     }
 453   }
 454
 455   void parsePavementNodeLine850(int num, const vector<string>& token)
 456   {
 457     double lat = atof( token[1].c_str() );
 458     double lon = atof( token[2].c_str() );
 459     SGGeod pos(SGGeod::fromDegFt(lon, lat, 0.0));
 460
 461     FGPavement* pvt = 0;
 462     if ( !pavement_ident.empty() ) {
 463       pvt = new FGPavement( 0, pavement_ident, pos );
 464       pavements.push_back( pvt );
 465       pavement_ident = "";
 466     } else {
 467       pvt = pavements.back();
 468     }
 469     if ( num == 112 || num == 114 ) {
 470       double lat_b = atof( token[3].c_str() );
 471       double lon_b = atof( token[4].c_str() );
 472       SGGeod pos_b(SGGeod::fromDegFt(lon_b, lat_b, 0.0));
 473       pvt->addBezierNode(pos, pos_b, num == 114);
 474     } else {
 475       pvt->addNode(pos, num == 113);
 476     }
 477   }
 478
 479   void parseCommLine(int lineId, const vector<string>& token)
 480   {
 481     if ( rwy_count <= 0 ) {
 482       SG_LOG( SG_GENERAL, SG_ALERT, "No runways; skipping comm for " + last_apt_id);
 483     }
 484
 485     SGGeod pos = SGGeod::fromDegFt(rwy_lon_accum / (double)rwy_count,
 486         rwy_lat_accum / (double)rwy_count, last_apt_elev);
 487
 488     // short int representing tens of kHz:
 489     int freqKhz = atoi(token[1].c_str()) * 10;
 490     int rangeNm = 50;
 491     FGPositioned::Type ty;
 492     // Make sure we only pass on stations with at least a name
 493     if (token.size() >2){
 494
 495         switch (lineId) {
 496             case 50:
 497                 ty = FGPositioned::FREQ_AWOS;
 498                 for( size_t i = 2; i < token.size(); ++i )
 499                 {
 500                   if( token[i] == "ATIS" )
 501                   {
 502                     ty = FGPositioned::FREQ_ATIS;
 503                     break;
 504                   }
 505                 }
 506                 break;
 507
 508             case 51:    ty = FGPositioned::FREQ_UNICOM; break;
 509             case 52:    ty = FGPositioned::FREQ_CLEARANCE; break;
 510             case 53:    ty = FGPositioned::FREQ_GROUND; break;
 511             case 54:    ty = FGPositioned::FREQ_TOWER; break;
 512             case 55:
 513             case 56:    ty = FGPositioned::FREQ_APP_DEP; break;
 514             default:
 515                 throw sg_range_exception("unsupported apt.dat comm station type");
 516         }
 517
 518       // Name can contain white spaces. All tokens after the second token are
 519       // part of the name.
 520       std::string name = token[2];
 521       for( size_t i = 3; i < token.size(); ++i )
 522         name += ' ' + token[i];
 523
 524       cache->insertCommStation(ty, name, pos, freqKhz, rangeNm, currentAirportID);
 525     }
 526     else SG_LOG( SG_GENERAL, SG_DEBUG, "Found unnamed comm. Skipping: " << lineId);
 527   }
 528
 529 };
 530
 531 // Load the airport data base from the specified aptdb file.  The
 532 // metar file is used to mark the airports as having metar available
 533 // or not.
 534 bool airportDBLoad( const SGPath &aptdb_file )
 535 {
 536   APTLoader ld;
 537   ld.parseAPT(aptdb_file);
 538   return true;
 539 }
 540
 541 bool metarDataLoad(const SGPath& metar_file)
 542 {
 543   sg_gzifstream metar_in( metar_file.str() );
 544   if ( !metar_in.is_open() ) {
 545     SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << metar_file );
 546     return false;
 547   }
 548
 549   NavDataCache* cache = NavDataCache::instance();
 550   string ident;
 551   while ( metar_in ) {
 552     metar_in >> ident;
 553     if ( ident == "#" || ident == "//" ) {
 554       metar_in >> skipeol;
 555     } else {
 556       cache->setAirportMetar(ident, true);
 557     }
 558   }
 559
 560   return true;
 561 }
 562
 563 } // of namespace flightgear