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/bucket/newbucket.hxx>
  43
  44 #include <string>
  45
  46 #include "simple.hxx"
  47 #include "runways.hxx"
  48 #include "pavement.hxx"
  49 #if ENABLE_ATCDCL
  50 #    include <ATCDCL/commlist.hxx>
  51 #else
  52   #include <ATC/atcutils.hxx>
  53 #endif
  54
  55 #include <iostream>
  56
  57 using namespace std;
  58
  59 static FGPositioned::Type fptypeFromRobinType(int aType)
  60 {
  61   switch (aType) {
  62   case 1: return FGPositioned::AIRPORT;
  63   case 16: return FGPositioned::SEAPORT;
  64   case 17: return FGPositioned::HELIPORT;
  65   default:
  66     SG_LOG(SG_GENERAL, SG_ALERT, "unsupported type:" << aType);
  67     throw sg_range_exception("Unsupported airport type", "fptypeFromRobinType");
  68   }
  69 }
  70
  71 class APTLoader
  72 {
  73 public:
  74
  75   APTLoader()
  76   :  last_apt_id(""),
  77      last_apt_name(""),
  78      last_apt_elev(0.0),
  79      last_apt_info(""),
  80      last_apt_type("")
  81   {}
  82
  83
  84
  85   void parseAPT(const string &aptdb_file, FGCommList *comm_list)
  86   {
  87     sg_gzifstream in( aptdb_file );
  88
  89     if ( !in.is_open() ) {
  90         SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << aptdb_file );
  91         exit(-1);
  92     }
  93
  94     string line;
  95     char tmp[2049];
  96     tmp[2048] = 0;
  97
  98     unsigned int line_id = 0;
  99     unsigned int line_num = 0;
 100
 101     while ( ! in.eof() ) {
 102       in.getline(tmp, 2048);
 103       line = tmp; // string copy, ack
 104       line_num++;
 105
 106       if ( !line.size() || isspace(tmp[0])) {
 107         continue;
 108       }
 109
 110       if (line.size() >= 3) {
 111           char *p = (char *)memchr(tmp, ' ', 3);
 112           if ( p )
 113               *p = 0;
 114       }
 115
 116       line_id = atoi(tmp);
 117       if ( tmp[0] == 'I' ) {
 118         // First line, indicates IBM (i.e. DOS line endings I
 119         // believe.)
 120
 121         // move past this line and read and discard the next line
 122         // which is the version and copyright information
 123         in.getline(tmp, 2048);
 124         // vector<string> vers_token = simgear::strutils::split( tmp );
 125         if ( strlen(tmp) > 4 ) {
 126            char *p = (char *)memchr(tmp, ' ', 4);
 127            if ( p )
 128               *p = 0;
 129         }
 130         SG_LOG( SG_GENERAL, SG_INFO, "Data file version = " << tmp );
 131       } else if ( line_id == 1 /* Airport */ ||
 132                     line_id == 16 /* Seaplane base */ ||
 133                     line_id == 17 /* Heliport */ ) {
 134         parseAirportLine(simgear::strutils::split(line));
 135       } else if ( line_id == 10 ) { // Runway v810
 136         parseRunwayLine810(simgear::strutils::split(line));
 137       } else if ( line_id == 100 ) { // Runway v850
 138         parseRunwayLine850(simgear::strutils::split(line));
 139       } else if ( line_id == 101 ) { // Water Runway v850
 140         parseWaterRunwayLine850(simgear::strutils::split(line));
 141       } else if ( line_id == 102 ) { // Helipad v850
 142         parseHelipadLine850(simgear::strutils::split(line));
 143       } else if ( line_id == 18 ) {
 144             // beacon entry (ignore)
 145       } else if ( line_id == 14 ) {
 146         // control tower entry
 147         vector<string> token(simgear::strutils::split(line));
 148
 149         double lat = atof( token[1].c_str() );
 150         double lon = atof( token[2].c_str() );
 151         double elev = atof( token[3].c_str() );
 152         tower = SGGeod::fromDegFt(lon, lat, elev + last_apt_elev);
 153         got_tower = true;
 154       } else if ( line_id == 19 ) {
 155           // windsock entry (ignore)
 156       } else if ( line_id == 20 ) {
 157           // Taxiway sign (ignore)
 158       } else if ( line_id == 21 ) {
 159           // lighting objects (ignore)
 160       } else if ( line_id == 15 ) {
 161           // custom startup locations (ignore)
 162       } else if ( line_id == 0 ) {
 163           // ??
 164       } else if ( line_id == 50 ) {
 165
 166         parseATISLine(comm_list, simgear::strutils::split(line));
 167
 168       } else if ( line_id >= 51 && line_id <= 56 ) {
 169         // other frequency entries (ignore)
 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 == 99 ) {
 183           SG_LOG( SG_GENERAL, SG_DEBUG, "End of file reached" );
 184       } else {
 185           SG_LOG( SG_GENERAL, SG_ALERT,
 186                   "Unknown line(#" << line_num << ") in file: " << line );
 187           exit( -1 );
 188       }
 189     }
 190
 191     addAirport();
 192   }
 193
 194 private:
 195   vector<string> token;
 196   double rwy_lat_accum;
 197   double rwy_lon_accum;
 198   double last_rwy_heading;
 199   int rwy_count;
 200   bool got_tower;
 201   string last_apt_id;
 202   string last_apt_name;
 203   double last_apt_elev;
 204   SGGeod tower;
 205   string last_apt_info;
 206   string last_apt_type;
 207   string pavement_ident;
 208   bool pavement;
 209
 210   vector<FGRunwayPtr> runways;
 211   vector<FGTaxiwayPtr> taxiways;
 212   vector<FGPavementPtr> pavements;
 213
 214   void addAirport()
 215   {
 216     if (last_apt_id.empty()) {
 217       return;
 218     }
 219
 220     if (!rwy_count) {
 221         SG_LOG(SG_GENERAL, SG_ALERT, "ERROR: No runways for " << last_apt_id
 222                 << ", skipping." );
 223         return;
 224     }
 225
 226     double lat = rwy_lat_accum / (double)rwy_count;
 227     double lon = rwy_lon_accum / (double)rwy_count;
 228
 229     if (!got_tower) {
 230         // tower height hard coded for now...
 231         const float tower_height = 50.0f;
 232         // make a little off the heading for 1 runway airports...
 233         float fudge_lon = fabs(sin(last_rwy_heading * SGD_DEGREES_TO_RADIANS)) * .003f;
 234         float fudge_lat = .003f - fudge_lon;
 235         tower = SGGeod::fromDegFt(lon + fudge_lon, lat + fudge_lat, last_apt_elev + tower_height);
 236     }
 237
 238     SGGeod pos(SGGeod::fromDegFt(lon, lat, last_apt_elev));
 239     FGAirport* apt = new FGAirport(last_apt_id, pos, tower, last_apt_name, false,
 240         fptypeFromRobinType(atoi(last_apt_type.c_str())));
 241     apt->setRunwaysAndTaxiways(runways, taxiways, pavements);
 242   }
 243
 244   void parseAirportLine(const vector<string>& token)
 245   {
 246     const string& id(token[4]);
 247     double elev = atof( token[1].c_str() );
 248
 249     addAirport();
 250
 251     last_apt_id = id;
 252     last_apt_elev = elev;
 253     last_apt_name = "";
 254     got_tower = false;
 255
 256     // build the name
 257     for ( unsigned int i = 5; i < token.size() - 1; ++i ) {
 258         last_apt_name += token[i];
 259         last_apt_name += " ";
 260     }
 261     last_apt_name += token[token.size() - 1];
 262     last_apt_type = token[0];
 263
 264     // clear runway list for start of next airport
 265     rwy_lon_accum = 0.0;
 266     rwy_lat_accum = 0.0;
 267     rwy_count = 0;
 268   }
 269
 270   void parseRunwayLine810(const vector<string>& token)
 271   {
 272     double lat = atof( token[1].c_str() );
 273     double lon = atof( token[2].c_str() );
 274     rwy_lat_accum += lat;
 275     rwy_lon_accum += lon;
 276     rwy_count++;
 277
 278     const string& rwy_no(token[3]);
 279
 280     double heading = atof( token[4].c_str() );
 281     double length = atoi( token[5].c_str() );
 282     double width = atoi( token[8].c_str() );
 283
 284     last_rwy_heading = heading;
 285
 286     int surface_code = atoi( token[10].c_str() );
 287     SGGeod pos(SGGeod::fromDegFt(lon, lat, last_apt_elev));
 288
 289     if (rwy_no[0] == 'x') {
 290       // taxiway
 291       FGTaxiway* t = new FGTaxiway(rwy_no, pos, heading, length, width, surface_code);
 292       taxiways.push_back(t);
 293     } else {
 294       // (pair of) runways
 295       string rwy_displ_threshold = token[6];
 296       vector<string> displ
 297           = simgear::strutils::split( rwy_displ_threshold, "." );
 298       double displ_thresh1 = atof( displ[0].c_str() );
 299       double displ_thresh2 = atof( displ[1].c_str() );
 300
 301       string rwy_stopway = token[7];
 302       vector<string> stop
 303           = simgear::strutils::split( rwy_stopway, "." );
 304       double stopway1 = atof( stop[0].c_str() );
 305       double stopway2 = atof( stop[1].c_str() );
 306
 307       FGRunway* rwy = new FGRunway(NULL, rwy_no, pos, heading, length,
 308                             width, displ_thresh1, stopway1, surface_code, false);
 309       runways.push_back(rwy);
 310
 311       FGRunway* reciprocal = new FGRunway(NULL, FGRunway::reverseIdent(rwy_no),
 312                 pos, heading + 180.0, length, width,
 313                 displ_thresh2, stopway2, surface_code, true);
 314
 315       runways.push_back(reciprocal);
 316
 317       rwy->setReciprocalRunway(reciprocal);
 318       reciprocal->setReciprocalRunway(rwy);
 319     }
 320   }
 321
 322   void parseRunwayLine850(const vector<string>& token)
 323   {
 324     double width = atof( token[1].c_str() ) * SG_METER_TO_FEET;
 325     int surface_code = atoi( token[2].c_str() );
 326
 327     double lat_1 = atof( token[9].c_str() );
 328     double lon_1 = atof( token[10].c_str() );
 329     SGGeod pos_1(SGGeod::fromDegFt(lon_1, lat_1, 0.0));
 330     rwy_lat_accum += lat_1;
 331     rwy_lon_accum += lon_1;
 332     rwy_count++;
 333
 334     double lat_2 = atof( token[18].c_str() );
 335     double lon_2 = atof( token[19].c_str() );
 336     SGGeod pos_2(SGGeod::fromDegFt(lon_2, lat_2, 0.0));
 337     rwy_lat_accum += lat_2;
 338     rwy_lon_accum += lon_2;
 339     rwy_count++;
 340
 341     double length, heading_1, heading_2, dummy;
 342     SGGeodesy::inverse( pos_1, pos_2, heading_1, heading_2, length );
 343     SGGeod pos;
 344     SGGeodesy::direct( pos_1, heading_1, length / 2.0, pos, dummy );
 345     length *= SG_METER_TO_FEET;
 346
 347     last_rwy_heading = heading_1;
 348
 349     const string& rwy_no_1(token[8]);
 350     const string& rwy_no_2(token[17]);
 351     if ( rwy_no_1.size() == 0 || rwy_no_2.size() == 0 )
 352         return;
 353
 354     double displ_thresh1 = atof( token[11].c_str() );
 355     double displ_thresh2 = atof( token[20].c_str() );
 356
 357     double stopway1 = atof( token[12].c_str() );
 358     double stopway2 = atof( token[21].c_str() );
 359
 360     FGRunway* rwy = new FGRunway(NULL, rwy_no_1, pos, heading_1, length,
 361                           width, displ_thresh1, stopway1, surface_code, false);
 362     runways.push_back(rwy);
 363
 364     FGRunway* reciprocal = new FGRunway(NULL, rwy_no_2,
 365               pos, heading_2, length, width,
 366               displ_thresh2, stopway2, surface_code, true);
 367     runways.push_back(reciprocal);
 368
 369     rwy->setReciprocalRunway(reciprocal);
 370     reciprocal->setReciprocalRunway(rwy);
 371   }
 372
 373   void parseWaterRunwayLine850(const vector<string>& token)
 374   {
 375     double width = atof( token[1].c_str() ) * SG_METER_TO_FEET;
 376
 377     double lat_1 = atof( token[4].c_str() );
 378     double lon_1 = atof( token[5].c_str() );
 379     SGGeod pos_1(SGGeod::fromDegFt(lon_1, lat_1, 0.0));
 380     rwy_lat_accum += lat_1;
 381     rwy_lon_accum += lon_1;
 382     rwy_count++;
 383
 384     double lat_2 = atof( token[7].c_str() );
 385     double lon_2 = atof( token[8].c_str() );
 386     SGGeod pos_2(SGGeod::fromDegFt(lon_2, lat_2, 0.0));
 387     rwy_lat_accum += lat_2;
 388     rwy_lon_accum += lon_2;
 389     rwy_count++;
 390
 391     double length, heading_1, heading_2, dummy;
 392     SGGeodesy::inverse( pos_1, pos_2, heading_1, heading_2, length );
 393     SGGeod pos;
 394     SGGeodesy::direct( pos_1, heading_1, length / 2.0, pos, dummy );
 395
 396     last_rwy_heading = heading_1;
 397
 398     const string& rwy_no_1(token[3]);
 399     const string& rwy_no_2(token[6]);
 400
 401     FGRunway* rwy = new FGRunway(NULL, rwy_no_1, pos, heading_1, length,
 402                           width, 0.0, 0.0, 13, false);
 403     runways.push_back(rwy);
 404
 405     FGRunway* reciprocal = new FGRunway(NULL, rwy_no_2,
 406               pos, heading_2, length, width,
 407               0.0, 0.0, 13, true);
 408     runways.push_back(reciprocal);
 409
 410     rwy->setReciprocalRunway(reciprocal);
 411     reciprocal->setReciprocalRunway(rwy);
 412   }
 413
 414   void parseHelipadLine850(const vector<string>& token)
 415   {
 416     double length = atof( token[5].c_str() ) * SG_METER_TO_FEET;
 417     double width = atof( token[6].c_str() ) * SG_METER_TO_FEET;
 418
 419     double lat = atof( token[2].c_str() );
 420     double lon = atof( token[3].c_str() );
 421     SGGeod pos(SGGeod::fromDegFt(lon, lat, 0.0));
 422     rwy_lat_accum += lat;
 423     rwy_lon_accum += lon;
 424     rwy_count++;
 425
 426     double heading = atof( token[4].c_str() );
 427
 428     last_rwy_heading = heading;
 429
 430     const string& rwy_no(token[1]);
 431     int surface_code = atoi( token[7].c_str() );
 432
 433     FGRunway* rwy = new FGRunway(NULL, rwy_no, pos, heading, length,
 434                           width, 0.0, 0.0, surface_code, false);
 435     runways.push_back(rwy);
 436   }
 437
 438   void parsePavementLine850(const vector<string>& token)
 439   {
 440     if ( token.size() >= 5 ) {
 441       pavement_ident = token[4];
 442       if ( !pavement_ident.empty() && pavement_ident[pavement_ident.size()-1] == '\r' )
 443         pavement_ident.erase( pavement_ident.size()-1 );
 444     } else {
 445       pavement_ident = "xx";
 446     }
 447   }
 448
 449   void parsePavementNodeLine850(int num, const vector<string>& token)
 450   {
 451     double lat = atof( token[1].c_str() );
 452     double lon = atof( token[2].c_str() );
 453     SGGeod pos(SGGeod::fromDegFt(lon, lat, 0.0));
 454
 455     FGPavement* pvt = 0;
 456     if ( !pavement_ident.empty() ) {
 457       pvt = new FGPavement( pavement_ident, pos );
 458       pavements.push_back( pvt );
 459       pavement_ident = "";
 460     } else {
 461       pvt = pavements.back();
 462     }
 463     if ( num == 112 || num == 114 ) {
 464       double lat_b = atof( token[3].c_str() );
 465       double lon_b = atof( token[4].c_str() );
 466       SGGeod pos_b(SGGeod::fromDegFt(lon_b, lat_b, 0.0));
 467       pvt->addBezierNode(pos, pos_b, num == 114);
 468     } else {
 469       pvt->addNode(pos, num == 113);
 470     }
 471   }
 472
 473   void parseATISLine(FGCommList *comm_list, const vector<string>& token)
 474   {
 475     if ( rwy_count <= 0 ) {
 476       SG_LOG( SG_GENERAL, SG_ALERT,
 477         "No runways; skipping AWOS for " + last_apt_id);
 478     }
 479
 480 // This assumes/requires that any code-50 line (ATIS or AWOS)
 481  // applies to the preceding code-1 line (airport ID and name)
 482  // and that a full set of code-10 lines (runway descriptors)
 483  // has come between the code-1 and code-50 lines.
 484             // typical code-50 lines:
 485             // 50 11770 ATIS
 486             // 50 11770 AWOS 3
 487  // This code parallels code found in "operator>>" in ATC.hxx;
 488  // FIXME: unify the code.
 489 #if ENABLE_ATCDCL
 490     ATCData a;
 491     a.geod = SGGeod::fromDegFt(rwy_lon_accum / (double)rwy_count,
 492       rwy_lat_accum / (double)rwy_count, last_apt_elev);
 493     a.range = 50;       // give all ATISs small range
 494     a.ident = last_apt_id;
 495     a.name = last_apt_name;
 496     // short int representing tens of kHz:
 497     a.freq = atoi(token[1].c_str());
 498     if (token[2] == "ATIS") a.type = ATIS;
 499     else a.type = AWOS;         // ASOS same as AWOS
 500
 501     // generate cartesian coordinates
 502     a.cart = SGVec3d::fromGeod(a.geod);
 503     comm_list->commlist_freq[a.freq].push_back(a);
 504
 505     SGBucket bucket(a.geod);
 506     int bucknum = bucket.gen_index();
 507     comm_list->commlist_bck[bucknum].push_back(a);
 508 #else
 509 #endif
 510 #if 0
 511    SG_LOG( SG_GENERAL, SG_ALERT,
 512      "Loaded ATIS/AWOS for airport: " << a.ident
 513     << "  lat: "  << a.geod.getLatitudeDeg()
 514     << "  lon: "  << a.geod.getLongitudeDeg()
 515     << "  freq: " << a.freq
 516     << "  type: " << a.type );
 517 #endif
 518   }
 519
 520 };
 521
 522
 523 // Load the airport data base from the specified aptdb file.  The
 524 // metar file is used to mark the airports as having metar available
 525 // or not.
 526 bool fgAirportDBLoad( const string &aptdb_file,
 527         FGCommList *comm_list, const std::string &metar_file )
 528 {
 529
 530    APTLoader ld;
 531    ld.parseAPT(aptdb_file, comm_list);
 532     //
 533     // Load the metar.dat file and update apt db with stations that
 534     // have metar data.
 535     //
 536
 537     sg_gzifstream metar_in( metar_file );
 538     if ( !metar_in.is_open() ) {
 539         SG_LOG( SG_GENERAL, SG_ALERT, "Cannot open file: " << metar_file );
 540     }
 541
 542     string ident;
 543     while ( metar_in ) {
 544         metar_in >> ident;
 545         if ( ident == "#" || ident == "//" ) {
 546             metar_in >> skipeol;
 547         } else {
 548             FGAirport* apt = FGAirport::findByIdent(ident);
 549             if (apt) {
 550                 apt->setMetar(true);
 551             }
 552         }
 553     }
 554
 555     SG_LOG(SG_GENERAL, SG_INFO, "[FINISHED LOADING]");
 556
 557     return true;
 558 }
 559