src/AIModel/AIFlightPlan.cxx

   1 // FGAIFlightPlan - class for loading and storing  AI flight plans
   2 // Written by David Culp, started May 2004
   3 // - davidculp2@comcast.net
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18
  19 #ifdef HAVE_CONFIG_H
  20 #  include <config.h>
  21 #endif
  22
  23 #include <iostream>
  24
  25 #include <simgear/misc/sg_path.hxx>
  26 #include <simgear/debug/logstream.hxx>
  27 #include <simgear/route/waypoint.hxx>
  28 #include <simgear/math/sg_geodesy.hxx>
  29 #include <simgear/structure/exception.hxx>
  30 #include <simgear/constants.h>
  31 #include <simgear/props/props.hxx>
  32 #include <simgear/props/props_io.hxx>
  33
  34 #include <Main/globals.hxx>
  35 #include <Main/fg_props.hxx>
  36 #include <Main/fg_init.hxx>
  37 #include <Airports/simple.hxx>
  38 #include <Airports/runways.hxx>
  39 #include <Airports/groundnetwork.hxx>
  40
  41 #include <Environment/environment_mgr.hxx>
  42 #include <Environment/environment.hxx>
  43
  44 #include "AIFlightPlan.hxx"
  45 #include "AIAircraft.hxx"
  46
  47 using std::cerr;
  48
  49 FGAIFlightPlan::FGAIFlightPlan()
  50 {
  51    sid = 0;
  52 }
  53
  54 FGAIFlightPlan::FGAIFlightPlan(const string& filename)
  55 {
  56   int i;
  57   sid = 0;
  58   start_time = 0;
  59   leg = 10;
  60   gateId = 0;
  61   taxiRoute = 0;
  62   SGPath path( globals->get_fg_root() );
  63   path.append( ("/AI/FlightPlans/" + filename).c_str() );
  64   SGPropertyNode root;
  65   repeat = false;
  66
  67   try {
  68       readProperties(path.str(), &root);
  69   } catch (const sg_exception &) {
  70       SG_LOG(SG_GENERAL, SG_ALERT,
  71        "Error reading AI flight plan: " << path.str());
  72        // cout << path.str() << endl;
  73      return;
  74   }
  75
  76   SGPropertyNode * node = root.getNode("flightplan");
  77   for (i = 0; i < node->nChildren(); i++) {
  78      //cout << "Reading waypoint " << i << endl;
  79      waypoint* wpt = new waypoint;
  80      SGPropertyNode * wpt_node = node->getChild(i);
  81      wpt->name      = wpt_node->getStringValue("name", "END");
  82      wpt->latitude  = wpt_node->getDoubleValue("lat", 0);
  83      wpt->longitude = wpt_node->getDoubleValue("lon", 0);
  84      wpt->altitude  = wpt_node->getDoubleValue("alt", 0);
  85      wpt->speed     = wpt_node->getDoubleValue("ktas", 0);
  86      wpt->crossat   = wpt_node->getDoubleValue("crossat", -10000);
  87      wpt->gear_down = wpt_node->getBoolValue("gear-down", false);
  88      wpt->flaps_down= wpt_node->getBoolValue("flaps-down", false);
  89      wpt->on_ground = wpt_node->getBoolValue("on-ground", false);
  90      wpt->time_sec   = wpt_node->getDoubleValue("time-sec", 0);
  91      wpt->time       = wpt_node->getStringValue("time", "");
  92
  93      if (wpt->name == "END") wpt->finished = true;
  94      else wpt->finished = false;
  95
  96      waypoints.push_back( wpt );
  97    }
  98
  99   wpt_iterator = waypoints.begin();
 100   //cout << waypoints.size() << " waypoints read." << endl;
 101 }
 102
 103
 104 // This is a modified version of the constructor,
 105 // Which not only reads the waypoints from a
 106 // Flight plan file, but also adds the current
 107 // Position computed by the traffic manager, as well
 108 // as setting speeds and altitude computed by the
 109 // traffic manager.
 110 FGAIFlightPlan::FGAIFlightPlan(FGAIAircraft *ac,
 111                                const std::string& p,
 112                                double course,
 113                                time_t start,
 114                                FGAirport *dep,
 115                                FGAirport *arr,
 116                                bool firstLeg,
 117                                double radius,
 118                                double alt,
 119                                double lat,
 120                                double lon,
 121                                double speed,
 122                                const string& fltType,
 123                                const string& acType,
 124                                const string& airline)
 125 {
 126   sid = 0;
 127   repeat = false;
 128   leg = 10;
 129   gateId=0;
 130   taxiRoute = 0;
 131   start_time = start;
 132   bool useInitialWayPoint = true;
 133   bool useCurrentWayPoint = false;
 134   SGPath path( globals->get_fg_root() );
 135   path.append( "/AI/FlightPlans" );
 136   path.append( p );
 137
 138   SGPropertyNode root;
 139
 140   // This is a bit of a hack:
 141   // Normally the value of course will be used to evaluate whether
 142   // or not a waypoint will be used for midair initialization of
 143   // an AI aircraft. However, if a course value of 999 will be passed
 144   // when an update request is received, which will by definition always be
 145   // on the ground and should include all waypoints.
 146   if (course == 999)
 147     {
 148       useInitialWayPoint = false;
 149       useCurrentWayPoint = true;
 150     }
 151
 152   if (path.exists())
 153     {
 154       try
 155         {
 156           readProperties(path.str(), &root);
 157
 158           SGPropertyNode * node = root.getNode("flightplan");
 159
 160           //waypoints.push_back( init_waypoint );
 161           for (int i = 0; i < node->nChildren(); i++) {
 162             //cout << "Reading waypoint " << i << endl;
 163             waypoint* wpt = new waypoint;
 164             SGPropertyNode * wpt_node = node->getChild(i);
 165             wpt->name      = wpt_node->getStringValue("name", "END");
 166             wpt->latitude  = wpt_node->getDoubleValue("lat", 0);
 167             wpt->longitude = wpt_node->getDoubleValue("lon", 0);
 168             wpt->altitude  = wpt_node->getDoubleValue("alt", 0);
 169             wpt->speed     = wpt_node->getDoubleValue("ktas", 0);
 170             //wpt->speed     = speed;
 171             wpt->crossat   = wpt_node->getDoubleValue("crossat", -10000);
 172             wpt->gear_down = wpt_node->getBoolValue("gear-down", false);
 173             wpt->flaps_down= wpt_node->getBoolValue("flaps-down", false);
 174
 175             if (wpt->name == "END") wpt->finished = true;
 176             else wpt->finished = false;
 177             waypoints.push_back(wpt);
 178           } // of node loop
 179         } catch (const sg_exception &e) {
 180       SG_LOG(SG_GENERAL, SG_WARN, "Error reading AI flight plan: " <<
 181         e.getMessage() << " from " << e.getOrigin());
 182     }
 183   } else {
 184       // cout << path.str() << endl;
 185       // cout << "Trying to create this plan dynamically" << endl;
 186       // cout << "Route from " << dep->id << " to " << arr->id << endl;
 187       time_t now = time(NULL) + fgGetLong("/sim/time/warp");
 188       time_t timeDiff = now-start;
 189       leg = 1;
 190       /*
 191       if ((timeDiff > 300) && (timeDiff < 1200))
 192         leg = 2;
 193       else if ((timeDiff >= 1200) && (timeDiff < 1500))
 194         leg = 3;
 195       else if ((timeDiff >= 1500) && (timeDiff < 2000))
 196         leg = 4;
 197       else if (timeDiff >= 2000)
 198         leg = 5;
 199       */
 200       if (timeDiff >= 2000)
 201           leg = 5;
 202
 203       SG_LOG(SG_GENERAL, SG_INFO, "Route from " << dep->getId() << " to " << arr->getId() << ". Set leg to : " << leg << " " << ac->getTrafficRef()->getCallSign());
 204       wpt_iterator = waypoints.begin();
 205       create(ac, dep,arr, leg, alt, speed, lat, lon,
 206              firstLeg, radius, fltType, acType, airline);
 207       wpt_iterator = waypoints.begin();
 208       //cerr << "after create: " << (*wpt_iterator)->name << endl;
 209       //leg++;
 210       // Now that we have dynamically created a flight plan,
 211       // we need to add some code that pops any waypoints already past.
 212       //return;
 213     }
 214   /*
 215     waypoint* init_waypoint   = new waypoint;
 216     init_waypoint->name       = string("initial position");
 217     init_waypoint->latitude   = entity->latitude;
 218     init_waypoint->longitude  = entity->longitude;
 219     init_waypoint->altitude   = entity->altitude;
 220     init_waypoint->speed      = entity->speed;
 221     init_waypoint->crossat    = - 10000;
 222     init_waypoint->gear_down  = false;
 223     init_waypoint->flaps_down = false;
 224     init_waypoint->finished   = false;
 225
 226     wpt_vector_iterator i = waypoints.begin();
 227     while (i != waypoints.end())
 228     {
 229       //cerr << "Checking status of each waypoint: " << (*i)->name << endl;
 230        SGWayPoint first(init_waypoint->longitude,
 231                        init_waypoint->latitude,
 232                        init_waypoint->altitude);
 233       SGWayPoint curr ((*i)->longitude,
 234                        (*i)->latitude,
 235                        (*i)->altitude);
 236       double crse, crsDiff;
 237       double dist;
 238       curr.CourseAndDistance(first, &crse, &dist);
 239
 240       dist *= SG_METER_TO_NM;
 241
 242       // We're only interested in the absolute value of crsDiff
 243       // wich should fall in the 0-180 deg range.
 244       crsDiff = fabs(crse-course);
 245       if (crsDiff > 180)
 246         crsDiff = 360-crsDiff;
 247       // These are the three conditions that we consider including
 248       // in our flight plan:
 249       // 1) current waypoint is less then 100 miles away OR
 250       // 2) curren waypoint is ahead of us, at any distance
 251
 252       if ((dist > 20.0) && (crsDiff > 90.0) && ((*i)->name != string ("EOF")))
 253         {
 254           //useWpt = false;
 255           // Once we start including waypoints, we have to continue, even though
 256           // one of the following way point would suffice.
 257           // so once is the useWpt flag is set to true, we cannot reset it to false.
 258           //cerr << "Discarding waypoint: " << (*i)->name
 259           //   << ": Course difference = " << crsDiff
 260           //  << "Course = " << course
 261           // << "crse   = " << crse << endl;
 262         }
 263       else
 264         useCurrentWayPoint = true;
 265
 266       if (useCurrentWayPoint)
 267         {
 268           if ((dist > 100.0) && (useInitialWayPoint))
 269             {
 270               //waypoints.push_back(init_waypoint);;
 271               waypoints.insert(i, init_waypoint);
 272               //cerr << "Using waypoint : " << init_waypoint->name <<  endl;
 273             }
 274           //if (useInitialWayPoint)
 275           // {
 276           //    (*i)->speed = dist; // A hack
 277           //  }
 278           //waypoints.push_back( wpt );
 279           //cerr << "Using waypoint : " << (*i)->name
 280           //  << ": course diff : " << crsDiff
 281           //   << "Course = " << course
 282           //   << "crse   = " << crse << endl
 283           //    << "distance      : " << dist << endl;
 284           useInitialWayPoint = false;
 285           i++;
 286         }
 287       else
 288         {
 289           //delete wpt;
 290           delete *(i);
 291           i = waypoints.erase(i);
 292           }
 293
 294         }
 295   */
 296   //for (i = waypoints.begin(); i != waypoints.end(); i++)
 297   //  cerr << "Using waypoint : " << (*i)->name << endl;
 298   //wpt_iterator = waypoints.begin();
 299   //cout << waypoints.size() << " waypoints read." << endl;
 300 }
 301
 302
 303
 304
 305 FGAIFlightPlan::~FGAIFlightPlan()
 306 {
 307   deleteWaypoints();
 308   delete taxiRoute;
 309 }
 310
 311
 312 FGAIFlightPlan::waypoint* const
 313 FGAIFlightPlan::getPreviousWaypoint( void ) const
 314 {
 315   if (wpt_iterator == waypoints.begin()) {
 316     return 0;
 317   } else {
 318     wpt_vector_iterator prev = wpt_iterator;
 319     return *(--prev);
 320   }
 321 }
 322
 323 FGAIFlightPlan::waypoint* const
 324 FGAIFlightPlan::getCurrentWaypoint( void ) const
 325 {
 326   return *wpt_iterator;
 327 }
 328
 329 FGAIFlightPlan::waypoint* const
 330 FGAIFlightPlan::getNextWaypoint( void ) const
 331 {
 332   wpt_vector_iterator i = waypoints.end();
 333   i--;  // end() points to one element after the last one.
 334   if (wpt_iterator == i) {
 335     return 0;
 336   } else {
 337     wpt_vector_iterator next = wpt_iterator;
 338     return *(++next);
 339   }
 340 }
 341
 342 void FGAIFlightPlan::IncrementWaypoint(bool eraseWaypoints )
 343 {
 344   if (eraseWaypoints)
 345     {
 346       if (wpt_iterator == waypoints.begin())
 347         wpt_iterator++;
 348       else
 349         {
 350           delete *(waypoints.begin());
 351           waypoints.erase(waypoints.begin());
 352           wpt_iterator = waypoints.begin();
 353           wpt_iterator++;
 354         }
 355     }
 356   else
 357     wpt_iterator++;
 358
 359 }
 360
 361 void FGAIFlightPlan::DecrementWaypoint(bool eraseWaypoints )
 362 {
 363     if (eraseWaypoints)
 364     {
 365         if (wpt_iterator == waypoints.end())
 366             wpt_iterator--;
 367         else
 368         {
 369             delete *(waypoints.end());
 370             waypoints.erase(waypoints.end());
 371             wpt_iterator = waypoints.end();
 372             wpt_iterator--;
 373         }
 374     }
 375     else
 376         wpt_iterator--;
 377
 378 }
 379
 380
 381 // gives distance in feet from a position to a waypoint
 382 double FGAIFlightPlan::getDistanceToGo(double lat, double lon, waypoint* wp) const{
 383   return SGGeodesy::distanceM(SGGeod::fromDeg(lon, lat),
 384       SGGeod::fromDeg(wp->longitude, wp->latitude));
 385 }
 386
 387 // sets distance in feet from a lead point to the current waypoint
 388 void FGAIFlightPlan::setLeadDistance(double speed, double bearing,
 389                                      waypoint* current, waypoint* next){
 390   double turn_radius;
 391   // Handle Ground steering
 392   // At a turn rate of 30 degrees per second, it takes 12 seconds to do a full 360 degree turn
 393   // So, to get an estimate of the turn radius, calculate the cicumference of the circle
 394   // we travel on. Get the turn radius by dividing by PI (*2).
 395   if (speed < 0.5) {
 396         lead_distance = 0.5;
 397         return;
 398   }
 399   if (speed < 25) {
 400        turn_radius = ((360/30)*fabs(speed)) / (2*M_PI);
 401   } else
 402       turn_radius = 0.1911 * speed * speed; // an estimate for 25 degrees bank
 403
 404   double inbound = bearing;
 405   double outbound = getBearing(current, next);
 406   leadInAngle = fabs(inbound - outbound);
 407   if (leadInAngle > 180.0)
 408     leadInAngle = 360.0 - leadInAngle;
 409   //if (leadInAngle < 30.0) // To prevent lead_dist from getting so small it is skipped
 410   //  leadInAngle = 30.0;
 411
 412   //lead_distance = turn_radius * sin(leadInAngle * SG_DEGREES_TO_RADIANS);
 413   lead_distance = turn_radius * tan((leadInAngle * SG_DEGREES_TO_RADIANS)/2);
 414   if ((lead_distance > (3*turn_radius)) && (current->on_ground == false)) {
 415       // cerr << "Warning: Lead-in distance is large. Inbound = " << inbound
 416       //      << ". Outbound = " << outbound << ". Lead in angle = " << leadInAngle  << ". Turn radius = " << turn_radius << endl;
 417        lead_distance = 3 * turn_radius;
 418        return;
 419   }
 420   if ((leadInAngle > 90) && (current->on_ground == true)) {
 421       lead_distance = turn_radius * tan((90 * SG_DEGREES_TO_RADIANS)/2);
 422       return;
 423   }
 424 }
 425
 426 void FGAIFlightPlan::setLeadDistance(double distance_ft){
 427   lead_distance = distance_ft;
 428 }
 429
 430
 431 double FGAIFlightPlan::getBearing(waypoint* first, waypoint* second) const{
 432   return getBearing(first->latitude, first->longitude, second);
 433 }
 434
 435
 436 double FGAIFlightPlan::getBearing(double lat, double lon, waypoint* wp) const{
 437   return SGGeodesy::courseDeg(SGGeod::fromDeg(lon, lat),
 438       SGGeod::fromDeg(wp->longitude, wp->latitude));
 439 }
 440
 441 void FGAIFlightPlan::deleteWaypoints()
 442 {
 443   for (wpt_vector_iterator i = waypoints.begin(); i != waypoints.end();i++)
 444     delete (*i);
 445   waypoints.clear();
 446 }
 447
 448 // Delete all waypoints except the last,
 449 // which we will recycle as the first waypoint in the next leg;
 450 void FGAIFlightPlan::resetWaypoints()
 451 {
 452   if (waypoints.begin() == waypoints.end())
 453     return;
 454   else
 455     {
 456       waypoint *wpt = new waypoint;
 457       wpt_vector_iterator i = waypoints.end();
 458       i--;
 459       wpt->name      = (*i)->name;
 460       wpt->latitude  = (*i)->latitude;
 461       wpt->longitude =  (*i)->longitude;
 462       wpt->altitude  =  (*i)->altitude;
 463       wpt->speed     =  (*i)->speed;
 464       wpt->crossat   =  (*i)->crossat;
 465       wpt->gear_down =  (*i)->gear_down;
 466       wpt->flaps_down=  (*i)->flaps_down;
 467       wpt->finished  = false;
 468       wpt->on_ground =  (*i)->on_ground;
 469       //cerr << "Recycling waypoint " << wpt->name << endl;
 470       deleteWaypoints();
 471       waypoints.push_back(wpt);
 472     }
 473 }
 474
 475 // Start flightplan over from the beginning
 476 void FGAIFlightPlan::restart()
 477 {
 478   wpt_iterator = waypoints.begin();
 479 }
 480
 481
 482 void FGAIFlightPlan::deleteTaxiRoute()
 483 {
 484   delete taxiRoute;
 485   taxiRoute = 0;
 486 }
 487
 488
 489 int FGAIFlightPlan::getRouteIndex(int i) {
 490   if ((i > 0) && (i < (int)waypoints.size())) {
 491     return waypoints[i]->routeIndex;
 492   }
 493   else
 494     return 0;
 495 }