src/AIModel/AIAircraft.cxx

   1 // // FGAIAircraft - FGAIBase-derived class creates an AI airplane
   2 //
   3 // Written by David Culp, started October 2003.
   4 //
   5 // Copyright (C) 2003  David P. Culp - davidculp2@comcast.net
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include <simgear/route/waypoint.hxx>
  26 #include <Main/fg_props.hxx>
  27 #include <Main/globals.hxx>
  28 #include <Main/viewer.hxx>
  29 #include <Scenery/scenery.hxx>
  30 #include <Scenery/tilemgr.hxx>
  31 #include <Airports/dynamics.hxx>
  32 #include <Airports/simple.hxx>
  33
  34 #include <string>
  35 #include <math.h>
  36 #include <time.h>
  37
  38 #ifdef _MSC_VER
  39 #  include <float.h>
  40 #  define finite _finite
  41 #elif defined(__sun) || defined(sgi)
  42 #  include <ieeefp.h>
  43 #endif
  44
  45 using std::string;
  46
  47 #include "AIAircraft.hxx"
  48 #include "performancedata.hxx"
  49 #include "performancedb.hxx"
  50
  51 //#include <Airports/trafficcontroller.hxx>
  52
  53 static string tempReg;
  54
  55 FGAIAircraft::FGAIAircraft(FGAISchedule *ref) :
  56      /* HOT must be disabled for AI Aircraft,
  57       * otherwise traffic detection isn't working as expected.*/
  58      FGAIBase(otAircraft, false)
  59 {
  60     trafficRef = ref;
  61     if (trafficRef) {
  62         groundOffset = trafficRef->getGroundOffset();
  63         setCallSign(trafficRef->getCallSign());
  64     }
  65     else
  66         groundOffset = 0;
  67
  68     fp              = 0;
  69     controller      = 0;
  70     prevController  = 0;
  71     towerController = 0;
  72     dt_count = 0;
  73     dt_elev_count = 0;
  74     use_perf_vs = true;
  75
  76     no_roll = false;
  77     tgt_speed = 0;
  78     speed = 0;
  79     groundTargetSpeed = 0;
  80
  81     // set heading and altitude locks
  82     hdg_lock = false;
  83     alt_lock = false;
  84     roll = 0;
  85     headingChangeRate = 0.0;
  86     headingError = 0;
  87     minBearing = 360;
  88     speedFraction =1.0;
  89
  90     holdPos = false;
  91     needsTaxiClearance = false;
  92     _needsGroundElevation = true;
  93
  94     _performance = 0; //TODO initialize to JET_TRANSPORT from PerformanceDB
  95     dt = 0;
  96     scheduledForTakeoff = false;
  97 }
  98
  99
 100 FGAIAircraft::~FGAIAircraft() {
 101     //delete fp;
 102     if (controller)
 103         controller->signOff(getID());
 104 }
 105
 106
 107 void FGAIAircraft::readFromScenario(SGPropertyNode* scFileNode) {
 108     if (!scFileNode)
 109         return;
 110
 111     FGAIBase::readFromScenario(scFileNode);
 112
 113     setPerformance(scFileNode->getStringValue("class", "jet_transport"));
 114     setFlightPlan(scFileNode->getStringValue("flightplan"),
 115                   scFileNode->getBoolValue("repeat", false));
 116     setCallSign(scFileNode->getStringValue("callsign"));
 117 }
 118
 119
 120 void FGAIAircraft::bind() {
 121     FGAIBase::bind();
 122
 123     props->tie("controls/gear/gear-down",
 124                SGRawValueMethods<FGAIAircraft,bool>(*this,
 125                                                     &FGAIAircraft::_getGearDown));
 126     props->tie("transponder-id",
 127                SGRawValueMethods<FGAIAircraft,const char*>(*this,
 128                                                     &FGAIAircraft::_getTransponderCode));
 129 }
 130
 131
 132 void FGAIAircraft::unbind() {
 133     FGAIBase::unbind();
 134
 135     props->untie("controls/gear/gear-down");
 136     props->untie("transponder-id");
 137 }
 138
 139
 140 void FGAIAircraft::update(double dt) {
 141     FGAIBase::update(dt);
 142     Run(dt);
 143     Transform();
 144 }
 145
 146 void FGAIAircraft::setPerformance(const std::string& acclass) {
 147      static PerformanceDB perfdb; //TODO make it a global service
 148      setPerformance(perfdb.getDataFor(acclass));
 149   }
 150
 151
 152  void FGAIAircraft::setPerformance(PerformanceData *ps) {
 153      _performance = ps;
 154   }
 155
 156
 157  void FGAIAircraft::Run(double dt) {
 158       FGAIAircraft::dt = dt;
 159
 160      bool outOfSight = false,
 161         flightplanActive = true;
 162      updatePrimaryTargetValues(flightplanActive, outOfSight); // target hdg, alt, speed
 163      if (outOfSight) {
 164         return;
 165      }
 166
 167      if (!flightplanActive) {
 168         groundTargetSpeed = 0;
 169      }
 170
 171      handleATCRequests(); // ATC also has a word to say
 172      updateSecondaryTargetValues(); // target roll, vertical speed, pitch
 173      updateActualState();
 174     // We currently have one situation in which an AIAircraft object is used that is not attached to the
 175     // AI manager. In this particular case, the AIAircraft is used to shadow the user's aircraft's behavior in the AI world.
 176     // Since we perhaps don't want a radar entry of our own aircraft, the following conditional should probably be adequate
 177     // enough
 178      if (manager)
 179         UpdateRadar(manager);
 180      checkVisibility();
 181   }
 182
 183 void FGAIAircraft::checkVisibility()
 184 {
 185   double visibility_meters = fgGetDouble("/environment/visibility-m");
 186   FGViewer* vw = globals->get_current_view();
 187   invisible = (SGGeodesy::distanceM(vw->getPosition(), pos) > visibility_meters);
 188 }
 189
 190
 191
 192 void FGAIAircraft::AccelTo(double speed) {
 193     tgt_speed = speed;
 194     if (!isStationary())
 195         _needsGroundElevation = true;
 196 }
 197
 198
 199 void FGAIAircraft::PitchTo(double angle) {
 200     tgt_pitch = angle;
 201     alt_lock = false;
 202 }
 203
 204
 205 void FGAIAircraft::RollTo(double angle) {
 206     tgt_roll = angle;
 207     hdg_lock = false;
 208 }
 209
 210
 211 void FGAIAircraft::YawTo(double angle) {
 212     tgt_yaw = angle;
 213 }
 214
 215
 216 void FGAIAircraft::ClimbTo(double alt_ft ) {
 217     tgt_altitude_ft = alt_ft;
 218     alt_lock = true;
 219 }
 220
 221
 222 void FGAIAircraft::TurnTo(double heading) {
 223     tgt_heading = heading;
 224     hdg_lock = true;
 225 }
 226
 227
 228 double FGAIAircraft::sign(double x) {
 229     if (x == 0.0)
 230         return x;
 231     else
 232         return x/fabs(x);
 233 }
 234
 235
 236 void FGAIAircraft::setFlightPlan(const std::string& flightplan, bool repeat) {
 237     if (!flightplan.empty()) {
 238         FGAIFlightPlan* fp = new FGAIFlightPlan(flightplan);
 239         fp->setRepeat(repeat);
 240         SetFlightPlan(fp);
 241     }
 242 }
 243
 244
 245 void FGAIAircraft::SetFlightPlan(FGAIFlightPlan *f) {
 246     delete fp;
 247     fp = f;
 248 }
 249
 250
 251 void FGAIAircraft::ProcessFlightPlan( double dt, time_t now ) {
 252
 253     // the one behind you
 254     FGAIWaypoint* prev = 0;
 255     // the one ahead
 256     FGAIWaypoint* curr = 0;
 257     // the next plus 1
 258     FGAIWaypoint* next = 0;
 259
 260     prev = fp->getPreviousWaypoint();
 261     curr = fp->getCurrentWaypoint();
 262     next = fp->getNextWaypoint();
 263
 264     dt_count += dt;
 265
 266     ///////////////////////////////////////////////////////////////////////////
 267     // Initialize the flightplan
 268     //////////////////////////////////////////////////////////////////////////
 269     if (!prev) {
 270         handleFirstWaypoint();
 271         return;
 272     }                            // end of initialization
 273     if (! fpExecutable(now))
 274           return;
 275     dt_count = 0;
 276
 277     double distanceToDescent;
 278     if(reachedEndOfCruise(distanceToDescent)) {
 279         if (!loadNextLeg(distanceToDescent)) {
 280             setDie(true);
 281             return;
 282         }
 283         prev = fp->getPreviousWaypoint();
 284         curr = fp->getCurrentWaypoint();
 285         next = fp->getNextWaypoint();
 286     }
 287     if (! leadPointReached(curr)) {
 288         controlHeading(curr);
 289         controlSpeed(curr, next);
 290             /*
 291             if (speed < 0) {
 292                 cerr << getCallSign()
 293                      << ": verifying lead distance to waypoint : "
 294                      << fp->getCurrentWaypoint()->name << " "
 295                      << fp->getLeadDistance() << ". Distance to go "
 296                      << (fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr))
 297                      << ". Target speed = "
 298                      << tgt_speed
 299                      << ". Current speed = "
 300                      << speed
 301                      << ". Minimum Bearing " << minBearing
 302                      << endl;
 303             } */
 304     } else {
 305         if (curr->isFinished())      //end of the flight plan
 306         {
 307             if (fp->getRepeat())
 308                 fp->restart();
 309             else
 310                 setDie(true);
 311             return;
 312         }
 313
 314         if (next) {
 315             //TODO more intelligent method in AIFlightPlan, no need to send data it already has :-)
 316             tgt_heading = fp->getBearing(curr, next);
 317             spinCounter = 0;
 318         }
 319
 320         //TODO let the fp handle this (loading of next leg)
 321         fp->IncrementWaypoint( trafficRef != 0 );
 322         if  ( ((!(fp->getNextWaypoint()))) && (trafficRef != 0) )
 323             if (!loadNextLeg()) {
 324                 setDie(true);
 325                 return;
 326             }
 327
 328         prev = fp->getPreviousWaypoint();
 329         curr = fp->getCurrentWaypoint();
 330         next = fp->getNextWaypoint();
 331
 332         // Now that we have incremented the waypoints, excute some traffic manager specific code
 333         if (trafficRef) {
 334             //TODO isn't this best executed right at the beginning?
 335             if (! aiTrafficVisible()) {
 336                 setDie(true);
 337                 return;
 338             }
 339
 340             if (! handleAirportEndPoints(prev, now)) {
 341                 setDie(true);
 342                 return;
 343             }
 344
 345             announcePositionToController();
 346
 347         }
 348
 349         if (next) {
 350             fp->setLeadDistance(tgt_speed, tgt_heading, curr, next);
 351         }
 352
 353         if (!(prev->getOn_ground()))  // only update the tgt altitude from flightplan if not on the ground
 354         {
 355             tgt_altitude_ft = prev->getAltitude();
 356             if (curr->getCrossat() > -1000.0) {
 357                 use_perf_vs = false;
 358                 tgt_vs = (curr->getCrossat() - altitude_ft) / (fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr)
 359                          / 6076.0 / speed*60.0);
 360                 checkTcas();
 361                 tgt_altitude_ft = curr->getCrossat();
 362             } else {
 363                 use_perf_vs = true;
 364             }
 365         }
 366         AccelTo(prev->getSpeed());
 367         hdg_lock = alt_lock = true;
 368         no_roll = prev->getOn_ground();
 369     }
 370 }
 371
 372 void FGAIAircraft::checkTcas(void)
 373 {
 374     if (props->getIntValue("tcas/threat-level",0)==3)
 375     {
 376         int RASense = props->getIntValue("tcas/ra-sense",0);
 377         if ((RASense>0)&&(tgt_vs<4000))
 378             // upward RA: climb!
 379             tgt_vs = 4000;
 380         else
 381         if (RASense<0)
 382         {
 383             // downward RA: descend!
 384             if (altitude_ft < 1000)
 385             {
 386                 // too low: level off
 387                 if (tgt_vs>0)
 388                     tgt_vs = 0;
 389             }
 390             else
 391             {
 392                 if (tgt_vs >- 4000)
 393                     tgt_vs = -4000;
 394             }
 395         }
 396     }
 397 }
 398
 399 void FGAIAircraft::initializeFlightPlan() {
 400 }
 401
 402
 403 bool FGAIAircraft::_getGearDown() const {
 404     return _performance->gearExtensible(this);
 405 }
 406
 407
 408 const char * FGAIAircraft::_getTransponderCode() const {
 409   return transponderCode.c_str();
 410 }
 411
 412 // NOTE: Check whether the new (delayed leg increment code has any effect on this code.
 413 // Probably not, because it should only be executed after we have already passed the leg incrementing waypoint.
 414
 415 bool FGAIAircraft::loadNextLeg(double distance) {
 416
 417     int leg;
 418     if ((leg = fp->getLeg())  == 9) {
 419         if (!trafficRef->next()) {
 420             return false;
 421         }
 422         setCallSign(trafficRef->getCallSign());
 423         leg = 0;
 424         fp->setLeg(leg);
 425     }
 426
 427     FGAirport *dep = trafficRef->getDepartureAirport();
 428     FGAirport *arr = trafficRef->getArrivalAirport();
 429     if (!(dep && arr)) {
 430         setDie(true);
 431
 432     } else {
 433         double cruiseAlt = trafficRef->getCruiseAlt() * 100;
 434
 435         fp->create (this,
 436                     dep,
 437                     arr,
 438                     leg+1,
 439                     cruiseAlt,
 440                     trafficRef->getSpeed(),
 441                     _getLatitude(),
 442                     _getLongitude(),
 443                     false,
 444                     trafficRef->getRadius(),
 445                     trafficRef->getFlightType(),
 446                     acType,
 447                     company,
 448                     distance);
 449        //cerr << "created  leg " << leg << " for " << trafficRef->getCallSign() << endl;
 450     }
 451     return true;
 452 }
 453
 454
 455 // Note: This code is copied from David Luff's AILocalTraffic
 456 // Warning - ground elev determination is CPU intensive
 457 // Either this function or the logic of how often it is called
 458 // will almost certainly change.
 459
 460 void FGAIAircraft::getGroundElev(double dt) {
 461     dt_elev_count += dt;
 462
 463     if (!needGroundElevation())
 464         return;
 465     // Update minimally every three secs, but add some randomness
 466     // to prevent all AI objects doing this in synchrony
 467     if (dt_elev_count < (3.0) + (rand() % 10))
 468         return;
 469
 470     dt_elev_count = 0;
 471
 472     // Only do the proper hitlist stuff if we are within visible range of the viewer.
 473     if (!invisible) {
 474         double visibility_meters = fgGetDouble("/environment/visibility-m");
 475         FGViewer* vw = globals->get_current_view();
 476
 477         if (SGGeodesy::distanceM(vw->getPosition(), pos) > visibility_meters) {
 478             return;
 479         }
 480
 481         double range = 500.0;
 482         if (globals->get_tile_mgr()->schedule_scenery(pos, range, 5.0))
 483         {
 484             double alt;
 485             if (getGroundElevationM(SGGeod::fromGeodM(pos, 20000), alt, 0))
 486             {
 487                 tgt_altitude_ft = alt * SG_METER_TO_FEET;
 488                 if (isStationary())
 489                 {
 490                     // aircraft is stationary and we obtained altitude for this spot - we're done.
 491                     _needsGroundElevation = false;
 492                 }
 493             }
 494         }
 495     }
 496 }
 497
 498
 499 void FGAIAircraft::doGroundAltitude() {
 500     if ((fabs(altitude_ft - (tgt_altitude_ft+groundOffset)) > 1000.0)||
 501         (isStationary()))
 502         altitude_ft = (tgt_altitude_ft + groundOffset);
 503     else
 504         altitude_ft += 0.1 * ((tgt_altitude_ft+groundOffset) - altitude_ft);
 505     tgt_vs = 0;
 506 }
 507
 508
 509 void FGAIAircraft::announcePositionToController() {
 510     if (trafficRef) {
 511         int leg = fp->getLeg();
 512
 513         // Note that leg has been incremented after creating the current leg, so we should use
 514         // leg numbers here that are one higher than the number that is used to create the leg
 515         // NOTE: As of July, 30, 2011, the post-creation leg updating is no longer happening.
 516         // Leg numbers are updated only once the aircraft passes the last waypoint created for that legm so I should probably just use
 517         // the original leg numbers here!
 518         switch (leg) {
 519           case 1:              // Startup and Push back
 520             if (trafficRef->getDepartureAirport()->getDynamics())
 521                 controller = trafficRef->getDepartureAirport()->getDynamics()->getStartupController();
 522             break;
 523         case 2:              // Taxiing to runway
 524             if (trafficRef->getDepartureAirport()->getDynamics()->getGroundNetwork()->exists())
 525                 controller = trafficRef->getDepartureAirport()->getDynamics()->getGroundNetwork();
 526             break;
 527         case 3:              //Take off tower controller
 528             if (trafficRef->getDepartureAirport()->getDynamics()) {
 529                 controller = trafficRef->getDepartureAirport()->getDynamics()->getTowerController();
 530             } else {
 531                 cerr << "Error: Could not find Dynamics at airport : " << trafficRef->getDepartureAirport()->getId() << endl;
 532             }
 533             break;
 534         case 6:
 535              if (trafficRef->getDepartureAirport()->getDynamics()) {
 536                  controller = trafficRef->getArrivalAirport()->getDynamics()->getApproachController();
 537               }
 538               break;
 539         case 8:              // Taxiing for parking
 540             if (trafficRef->getArrivalAirport()->getDynamics()->getGroundNetwork()->exists())
 541                 controller = trafficRef->getArrivalAirport()->getDynamics()->getGroundNetwork();
 542             break;
 543         default:
 544             controller = 0;
 545             break;
 546         }
 547
 548         if ((controller != prevController) && (prevController != 0)) {
 549             prevController->signOff(getID());
 550         }
 551         prevController = controller;
 552         if (controller) {
 553             controller->announcePosition(getID(), fp, fp->getCurrentWaypoint()->getRouteIndex(),
 554                                          _getLatitude(), _getLongitude(), hdg, speed, altitude_ft,
 555                                          trafficRef->getRadius(), leg, this);
 556         }
 557     }
 558 }
 559
 560 void FGAIAircraft::scheduleForATCTowerDepartureControl() {
 561     if (!scheduledForTakeoff) {
 562         int leg = fp->getLeg();
 563         if (trafficRef) {
 564             if (trafficRef->getDepartureAirport()->getDynamics()) {
 565                 towerController = trafficRef->getDepartureAirport()->getDynamics()->getTowerController();
 566             } else {
 567                 cerr << "Error: Could not find Dynamics at airport : " << trafficRef->getDepartureAirport()->getId() << endl;
 568             }
 569             if (towerController) {
 570                 towerController->announcePosition(getID(), fp, fp->getCurrentWaypoint()->getRouteIndex(),
 571                                                    _getLatitude(), _getLongitude(), hdg, speed, altitude_ft,
 572                                                     trafficRef->getRadius(), leg, this);
 573             }
 574         }
 575     }
 576     scheduledForTakeoff = true;
 577 }
 578
 579 // Process ATC instructions and report back
 580
 581 void FGAIAircraft::processATC(FGATCInstruction instruction) {
 582     if (instruction.getCheckForCircularWait()) {
 583         // This is not exactly an elegant solution,
 584         // but at least it gives me a chance to check
 585         // if circular waits are resolved.
 586         // For now, just take the offending aircraft
 587         // out of the scene
 588         setDie(true);
 589         // a more proper way should be - of course - to
 590         // let an offending aircraft take an evasive action
 591         // for instance taxi back a little bit.
 592     }
 593     //cerr << "Processing ATC instruction (not Implimented yet)" << endl;
 594     if (instruction.getHoldPattern   ()) {}
 595
 596     // Hold Position
 597     if (instruction.getHoldPosition  ()) {
 598         if (!holdPos) {
 599             holdPos = true;
 600         }
 601         AccelTo(0.0);
 602     } else {
 603         if (holdPos) {
 604             //if (trafficRef)
 605             //  cerr << trafficRef->getCallSign() << " Resuming Taxi." << endl;
 606             holdPos = false;
 607         }
 608         // Change speed Instruction. This can only be excecuted when there is no
 609         // Hold position instruction.
 610         if (instruction.getChangeSpeed   ()) {
 611             //  if (trafficRef)
 612             //cerr << trafficRef->getCallSign() << " Changing Speed " << endl;
 613             AccelTo(instruction.getSpeed());
 614         } else {
 615             if (fp) AccelTo(fp->getPreviousWaypoint()->getSpeed());
 616         }
 617     }
 618     if (instruction.getChangeHeading ()) {
 619         hdg_lock = false;
 620         TurnTo(instruction.getHeading());
 621     } else {
 622         if (fp) {
 623             hdg_lock = true;
 624         }
 625     }
 626     if (instruction.getChangeAltitude()) {}
 627
 628 }
 629
 630
 631 void FGAIAircraft::handleFirstWaypoint() {
 632     bool eraseWaypoints;         //TODO YAGNI
 633     headingError = 0;
 634     if (trafficRef) {
 635         eraseWaypoints = true;
 636     } else {
 637         eraseWaypoints = false;
 638     }
 639
 640     FGAIWaypoint* prev = 0; // the one behind you
 641     FGAIWaypoint* curr = 0; // the one ahead
 642     FGAIWaypoint* next = 0;// the next plus 1
 643
 644     spinCounter = 0;
 645     tempReg = "";
 646
 647     //TODO fp should handle this
 648     fp->IncrementWaypoint(eraseWaypoints);
 649     if (!(fp->getNextWaypoint()) && trafficRef)
 650         if (!loadNextLeg()) {
 651             setDie(true);
 652             return;
 653         }
 654
 655     prev = fp->getPreviousWaypoint();   //first waypoint
 656     curr = fp->getCurrentWaypoint();    //second waypoint
 657     next = fp->getNextWaypoint();       //third waypoint (might not exist!)
 658
 659     setLatitude(prev->getLatitude());
 660     setLongitude(prev->getLongitude());
 661     setSpeed(prev->getSpeed());
 662     setAltitude(prev->getAltitude());
 663
 664     if (prev->getSpeed() > 0.0)
 665         setHeading(fp->getBearing(prev->getLatitude(), prev->getLongitude(), curr));
 666     else
 667         setHeading(fp->getBearing(curr->getLatitude(), curr->getLongitude(), prev));
 668
 669     // If next doesn't exist, as in incrementally created flightplans for
 670     // AI/Trafficmanager created plans,
 671     // Make sure lead distance is initialized otherwise
 672     if (next)
 673         fp->setLeadDistance(speed, hdg, curr, next);
 674
 675     if (curr->getCrossat() > -1000.0) //use a calculated descent/climb rate
 676     {
 677         use_perf_vs = false;
 678         tgt_vs = (curr->getCrossat() - prev->getAltitude())
 679                  / (fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr)
 680                     / 6076.0 / prev->getSpeed()*60.0);
 681         checkTcas();
 682         tgt_altitude_ft = curr->getCrossat();
 683     } else {
 684         use_perf_vs = true;
 685         tgt_altitude_ft = prev->getAltitude();
 686     }
 687     alt_lock = hdg_lock = true;
 688     no_roll = prev->getOn_ground();
 689     if (no_roll) {
 690         Transform();             // make sure aip is initialized.
 691         getGroundElev(60.1);     // make sure it's executed first time around, so force a large dt value
 692         doGroundAltitude();
 693         _needsGroundElevation = true; // check ground elevation again (maybe scenery wasn't available yet)
 694     }
 695     // Make sure to announce the aircraft's position
 696     announcePositionToController();
 697     prevSpeed = 0;
 698 }
 699
 700
 701 /**
 702  * Check Execution time (currently once every 100 ms)
 703  * Add a bit of randomization to prevent the execution of all flight plans
 704  * in synchrony, which can add significant periodic framerate flutter.
 705  *
 706  * @param now
 707  * @return
 708  */
 709 bool FGAIAircraft::fpExecutable(time_t now) {
 710     double rand_exec_time = (rand() % 100) / 100;
 711     return (dt_count > (0.1+rand_exec_time)) && (fp->isActive(now));
 712 }
 713
 714
 715 /**
 716  * Check to see if we've reached the lead point for our next turn
 717  *
 718  * @param curr
 719  * @return
 720  */
 721 bool FGAIAircraft::leadPointReached(FGAIWaypoint* curr) {
 722     double dist_to_go = fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr);
 723
 724     //cerr << "2" << endl;
 725     double lead_dist = fp->getLeadDistance();
 726     // experimental: Use fabs, because speed can be negative (I hope) during push_back.
 727     if ((dist_to_go < fabs(10.0* speed)) && (speed < 0) && (tgt_speed < 0) && fp->getCurrentWaypoint()->contains("PushBackPoint")) {
 728           tgt_speed = -(dist_to_go / 10.0);
 729           if (tgt_speed > -0.5) {
 730                 tgt_speed = -0.5;
 731           }
 732           if (fp->getPreviousWaypoint()->getSpeed() < tgt_speed) {
 733               fp->getPreviousWaypoint()->setSpeed(tgt_speed);
 734           }
 735     }
 736     if (lead_dist < fabs(2*speed)) {
 737       //don't skip over the waypoint
 738       lead_dist = fabs(2*speed);
 739       //cerr << "Extending lead distance to " << lead_dist << endl;
 740     }
 741
 742     //prev_dist_to_go = dist_to_go;
 743     //if (dist_to_go < lead_dist)
 744     //     cerr << trafficRef->getCallSign() << " Distance : "
 745     //          << dist_to_go << ": Lead distance "
 746     //          << lead_dist << " " << curr->name
 747     //          << " Ground target speed " << groundTargetSpeed << endl;
 748     double bearing = 0;
 749     if (speed > 50) { // don't do bearing calculations for ground traffic
 750        bearing = getBearing(fp->getBearing(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr));
 751        if (bearing < minBearing) {
 752             minBearing = bearing;
 753             if (minBearing < 10) {
 754                  minBearing = 10;
 755             }
 756             if ((minBearing < 360.0) && (minBearing > 10.0)) {
 757                 speedFraction = cos(minBearing *SG_DEGREES_TO_RADIANS);
 758             } else {
 759                 speedFraction = 1.0;
 760             }
 761        }
 762     }
 763     if (trafficRef) {
 764          //cerr << "Tracking callsign : \"" << fgGetString("/ai/track-callsign") << "\"" << endl;
 765 /*         if (trafficRef->getCallSign() == fgGetString("/ai/track-callsign")) {
 766               cerr << trafficRef->getCallSign() << " " << tgt_altitude_ft << " " << _getSpeed() << " "
 767                    << _getAltitude() << " "<< _getLatitude() << " " << _getLongitude() << " " << dist_to_go << " " << lead_dist << " " << curr->name << " " << vs << " " << tgt_vs << " " << bearing << " " << minBearing << " " << speedFraction << endl;
 768          }*/
 769      }
 770     if ((dist_to_go < lead_dist) || (bearing > (minBearing * 1.1))) {
 771         minBearing = 360;
 772         return true;
 773     } else {
 774         return false;
 775     }
 776 }
 777
 778
 779 bool FGAIAircraft::aiTrafficVisible() {
 780   SGGeod userPos(SGGeod::fromDeg(fgGetDouble("/position/longitude-deg"),
 781     fgGetDouble("/position/latitude-deg")));
 782
 783   return (SGGeodesy::distanceNm(userPos, pos) <= TRAFFICTOAIDISTTODIE);
 784 }
 785
 786
 787 /**
 788  * Handle release of parking gate, once were taxiing. Also ensure service time at the gate
 789  * in the case of an arrival.
 790  *
 791  * @param prev
 792  * @return
 793  */
 794
 795 //TODO the trafficRef is the right place for the method
 796 bool FGAIAircraft::handleAirportEndPoints(FGAIWaypoint* prev, time_t now) {
 797     // prepare routing from one airport to another
 798     FGAirport * dep = trafficRef->getDepartureAirport();
 799     FGAirport * arr = trafficRef->getArrivalAirport();
 800
 801     if (!( dep && arr))
 802         return false;
 803
 804     // This waypoint marks the fact that the aircraft has passed the initial taxi
 805     // departure waypoint, so it can release the parking.
 806     //cerr << trafficRef->getCallSign() << " has passed waypoint " << prev->name << " at speed " << speed << endl;
 807     if (prev->contains("PushBackPoint")) {
 808         dep->getDynamics()->releaseParking(fp->getGate());
 809         AccelTo(0.0);
 810         setTaxiClearanceRequest(true);
 811     }
 812     if (prev->contains("legend")) {
 813         fp->incrementLeg();
 814     }
 815     if (prev->contains(string("DepartureHold"))) {
 816         scheduleForATCTowerDepartureControl();
 817     }
 818
 819     // This is the last taxi waypoint, and marks the the end of the flight plan
 820     // so, the schedule should update and wait for the next departure time.
 821     if (prev->contains("END")) {
 822         time_t nextDeparture = trafficRef->getDepartureTime();
 823         // make sure to wait at least 20 minutes at parking to prevent "nervous" taxi behavior
 824         if (nextDeparture < (now+1200)) {
 825             nextDeparture = now + 1200;
 826         }
 827         fp->setTime(nextDeparture); // should be "next departure"
 828     }
 829
 830     return true;
 831 }
 832
 833
 834 /**
 835  * Check difference between target bearing and current heading and correct if necessary.
 836  *
 837  * @param curr
 838  */
 839 void FGAIAircraft::controlHeading(FGAIWaypoint* curr) {
 840     double calc_bearing = fp->getBearing(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr);
 841     //cerr << "Bearing = " << calc_bearing << endl;
 842     if (speed < 0) {
 843         calc_bearing +=180;
 844         if (calc_bearing > 360)
 845             calc_bearing -= 360;
 846     }
 847
 848     if (finite(calc_bearing)) {
 849         double hdg_error = calc_bearing - tgt_heading;
 850         if (fabs(hdg_error) > 0.01) {
 851             TurnTo( calc_bearing );
 852         }
 853
 854     } else {
 855         cerr << "calc_bearing is not a finite number : "
 856         << "Speed " << speed
 857         << "pos : " << pos.getLatitudeDeg() << ", " << pos.getLongitudeDeg()
 858         << "waypoint " << curr->getLatitude() << ", " << curr->getLongitude() << endl;
 859         cerr << "waypoint name " << curr->getName();
 860         exit(1);                 // FIXME
 861     }
 862 }
 863
 864
 865 /**
 866  * Update the lead distance calculation if speed has changed sufficiently
 867  * to prevent spinning (hopefully);
 868  *
 869  * @param curr
 870  * @param next
 871  */
 872 void FGAIAircraft::controlSpeed(FGAIWaypoint* curr, FGAIWaypoint* next) {
 873     double speed_diff = speed - prevSpeed;
 874
 875     if (fabs(speed_diff) > 10) {
 876         prevSpeed = speed;
 877         if (next) {
 878             fp->setLeadDistance(speed, tgt_heading, curr, next);
 879         }
 880     }
 881 }
 882
 883
 884 /**
 885  * Update target values (heading, alt, speed) depending on flight plan or control properties
 886  */
 887 void FGAIAircraft::updatePrimaryTargetValues(bool& flightplanActive, bool& aiOutOfSight) {
 888     if (fp)                      // AI object has a flightplan
 889     {
 890         //TODO make this a function of AIBase
 891         time_t now = time(NULL) + fgGetLong("/sim/time/warp");
 892         //cerr << "UpateTArgetValues() " << endl;
 893         ProcessFlightPlan(dt, now);
 894
 895         // Do execute Ground elev for inactive aircraft, so they
 896         // Are repositioned to the correct ground altitude when the user flies within visibility range.
 897         // In addition, check whether we are out of user range, so this aircraft
 898         // can be deleted.
 899         if (onGround()) {
 900                 Transform();     // make sure aip is initialized.
 901                 getGroundElev(dt);
 902                 doGroundAltitude();
 903                 // Transform();
 904                 pos.setElevationFt(altitude_ft);
 905         }
 906         if (trafficRef) {
 907            //cerr << trafficRef->getRegistration() << " Setting altitude to " << altitude_ft;
 908             aiOutOfSight = !aiTrafficVisible();
 909             if (aiOutOfSight) {
 910                 setDie(true);
 911                 //cerr << trafficRef->getRegistration() << " is set to die " << endl;
 912                 aiOutOfSight = true;
 913                 return;
 914             }
 915         }
 916         timeElapsed = now - fp->getStartTime();
 917         flightplanActive = fp->isActive(now);
 918     } else {
 919         // no flight plan, update target heading, speed, and altitude
 920         // from control properties.  These default to the initial
 921         // settings in the config file, but can be changed "on the
 922         // fly".
 923         string lat_mode = props->getStringValue("controls/flight/lateral-mode");
 924         if ( lat_mode == "roll" ) {
 925             double angle
 926             = props->getDoubleValue("controls/flight/target-roll" );
 927             RollTo( angle );
 928         } else {
 929             double angle
 930             = props->getDoubleValue("controls/flight/target-hdg" );
 931             TurnTo( angle );
 932         }
 933
 934         string lon_mode
 935         = props->getStringValue("controls/flight/longitude-mode");
 936         if ( lon_mode == "alt" ) {
 937             double alt = props->getDoubleValue("controls/flight/target-alt" );
 938             ClimbTo( alt );
 939         } else {
 940             double angle
 941             = props->getDoubleValue("controls/flight/target-pitch" );
 942             PitchTo( angle );
 943         }
 944
 945         AccelTo( props->getDoubleValue("controls/flight/target-spd" ) );
 946     }
 947 }
 948
 949 void FGAIAircraft::updatePosition() {
 950     // convert speed to degrees per second
 951     double speed_north_deg_sec = cos( hdg * SGD_DEGREES_TO_RADIANS )
 952                                  * speed * 1.686 / ft_per_deg_lat;
 953     double speed_east_deg_sec  = sin( hdg * SGD_DEGREES_TO_RADIANS )
 954                                  * speed * 1.686 / ft_per_deg_lon;
 955
 956     // set new position
 957     pos.setLatitudeDeg( pos.getLatitudeDeg() + speed_north_deg_sec * dt);
 958     pos.setLongitudeDeg( pos.getLongitudeDeg() + speed_east_deg_sec * dt);
 959 }
 960
 961
 962 void FGAIAircraft::updateHeading() {
 963     // adjust heading based on current bank angle
 964     if (roll == 0.0)
 965         roll = 0.01;
 966
 967     if (roll != 0.0) {
 968         // double turnConstant;
 969         //if (no_roll)
 970         //  turnConstant = 0.0088362;
 971         //else
 972         //  turnConstant = 0.088362;
 973         // If on ground, calculate heading change directly
 974         if (onGround()) {
 975             double headingDiff = fabs(hdg-tgt_heading);
 976             double bank_sense = 0.0;
 977         /*
 978         double diff = fabs(hdg - tgt_heading);
 979         if (diff > 180)
 980             diff = fabs(diff - 360);
 981
 982         double sum = hdg + diff;
 983         if (sum > 360.0)
 984             sum -= 360.0;
 985         if (fabs(sum - tgt_heading) < 1.0) {
 986             bank_sense = 1.0;    // right turn
 987         } else {
 988             bank_sense = -1.0;   // left turn
 989         }*/
 990             if (headingDiff > 180)
 991                 headingDiff = fabs(headingDiff - 360);
 992             double sum = hdg + headingDiff;
 993             if (sum > 360.0)
 994                 sum -= 360.0;
 995             if (fabs(sum - tgt_heading) > 0.0001) {
 996                 bank_sense = -1.0;
 997             } else {
 998                 bank_sense = 1.0;
 999             }
1000             //if (trafficRef)
1001             //  cerr << trafficRef->getCallSign() << " Heading "
1002             //         << hdg << ". Target " << tgt_heading <<  ". Diff " << fabs(sum - tgt_heading) << ". Speed " << speed << endl;
1003             //if (headingDiff > 60) {
1004             groundTargetSpeed = tgt_speed; // * cos(headingDiff * SG_DEGREES_TO_RADIANS);
1005                 //groundTargetSpeed = tgt_speed - tgt_speed * (headingDiff/180);
1006             //} else {
1007             //    groundTargetSpeed = tgt_speed;
1008             //}
1009             if (sign(groundTargetSpeed) != sign(tgt_speed))
1010                 groundTargetSpeed = 0.21 * sign(tgt_speed); // to prevent speed getting stuck in 'negative' mode
1011
1012             // Only update the target values when we're not moving because otherwise we might introduce an enormous target change rate while waiting a the gate, or holding.
1013             if (speed != 0) {
1014                 if (headingDiff > 30.0) {
1015                     // invert if pushed backward
1016                     headingChangeRate += 10.0 * dt * sign(roll);
1017
1018                     // Clamp the maximum steering rate to 30 degrees per second,
1019                     // But only do this when the heading error is decreasing.
1020                     if ((headingDiff < headingError)) {
1021                         if (headingChangeRate > 30)
1022                             headingChangeRate = 30;
1023                         else if (headingChangeRate < -30)
1024                             headingChangeRate = -30;
1025                     }
1026                 } else {
1027                     if (speed != 0) {
1028                         if (fabs(headingChangeRate) > headingDiff)
1029                             headingChangeRate = headingDiff*sign(roll);
1030                         else
1031                             headingChangeRate += dt * sign(roll);
1032                     }
1033                 }
1034             }
1035             if (trafficRef)
1036                 //cerr << trafficRef->getCallSign() << " Heading "
1037                 //     << hdg << ". Target " << tgt_heading <<  ". Diff " << fabs(sum - tgt_heading) << ". Speed " << speed << "Heading change rate : " << headingChangeRate << " bacnk sence " << bank_sense << endl;
1038             hdg += headingChangeRate * dt * sqrt(fabs(speed) / 15);
1039             headingError = headingDiff;
1040         } else {
1041             if (fabs(speed) > 1.0) {
1042                 turn_radius_ft = 0.088362 * speed * speed
1043                                  / tan( fabs(roll) / SG_RADIANS_TO_DEGREES );
1044             } else {
1045                 // Check if turn_radius_ft == 0; this might lead to a division by 0.
1046                 turn_radius_ft = 1.0;
1047             }
1048             double turn_circum_ft = SGD_2PI * turn_radius_ft;
1049             double dist_covered_ft = speed * 1.686 * dt;
1050             double alpha = dist_covered_ft / turn_circum_ft * 360.0;
1051             hdg += alpha * sign(roll);
1052         }
1053         while ( hdg > 360.0 ) {
1054             hdg -= 360.0;
1055             spinCounter++;
1056         }
1057         while ( hdg < 0.0) {
1058             hdg += 360.0;
1059             spinCounter--;
1060         }
1061     }
1062 }
1063
1064
1065 void FGAIAircraft::updateBankAngleTarget() {
1066     // adjust target bank angle if heading lock engaged
1067     if (hdg_lock) {
1068         double bank_sense = 0.0;
1069         double diff = fabs(hdg - tgt_heading);
1070         if (diff > 180)
1071             diff = fabs(diff - 360);
1072
1073         double sum = hdg + diff;
1074         if (sum > 360.0)
1075             sum -= 360.0;
1076         if (fabs(sum - tgt_heading) < 1.0) {
1077             bank_sense = 1.0;    // right turn
1078         } else {
1079             bank_sense = -1.0;   // left turn
1080         }
1081         if (diff < _performance->maximumBankAngle()) {
1082             tgt_roll = diff * bank_sense;
1083         } else {
1084             tgt_roll = _performance->maximumBankAngle() * bank_sense;
1085         }
1086         if ((fabs((double) spinCounter) > 1) && (diff > _performance->maximumBankAngle())) {
1087             tgt_speed *= 0.999;  // Ugly hack: If aircraft get stuck, they will continually spin around.
1088             // The only way to resolve this is to make them slow down.
1089         }
1090     }
1091 }
1092
1093
1094 void FGAIAircraft::updateVerticalSpeedTarget() {
1095     // adjust target Altitude, based on ground elevation when on ground
1096     if (onGround()) {
1097         getGroundElev(dt);
1098         doGroundAltitude();
1099     } else if (alt_lock) {
1100         // find target vertical speed
1101         if (use_perf_vs) {
1102             if (altitude_ft < tgt_altitude_ft) {
1103                 tgt_vs = tgt_altitude_ft - altitude_ft;
1104                 if (tgt_vs > _performance->climbRate())
1105                     tgt_vs = _performance->climbRate();
1106             } else {
1107                 tgt_vs = tgt_altitude_ft - altitude_ft;
1108                 if (tgt_vs  < (-_performance->descentRate()))
1109                     tgt_vs = -_performance->descentRate();
1110             }
1111         } else {
1112             double max_vs = 4*(tgt_altitude_ft - altitude_ft);
1113             double min_vs = 100;
1114             if (tgt_altitude_ft < altitude_ft)
1115                 min_vs = -100.0;
1116             if ((fabs(tgt_altitude_ft - altitude_ft) < 1500.0)
1117                     && (fabs(max_vs) < fabs(tgt_vs)))
1118                 tgt_vs = max_vs;
1119
1120             if (fabs(tgt_vs) < fabs(min_vs))
1121                 tgt_vs = min_vs;
1122         }
1123     } //else
1124     //    tgt_vs = 0.0;
1125     checkTcas();
1126 }
1127
1128 void FGAIAircraft::updatePitchAngleTarget() {
1129     // if on ground and above vRotate -> initial rotation
1130     if (onGround() && (speed > _performance->vRotate()))
1131         tgt_pitch = 8.0; // some rough B737 value
1132
1133     //TODO pitch angle on approach and landing
1134
1135     // match pitch angle to vertical speed
1136     else if (tgt_vs > 0) {
1137         tgt_pitch = tgt_vs * 0.005;
1138     } else {
1139         tgt_pitch = tgt_vs * 0.002;
1140     }
1141 }
1142
1143 string FGAIAircraft::atGate() {
1144      string tmp("");
1145      if (fp->getLeg() < 3) {
1146          if (trafficRef) {
1147              if (fp->getGate() > 0) {
1148                  FGParking *park =
1149                      trafficRef->getDepartureAirport()->getDynamics()->getParking(fp->getGate());
1150                  tmp = park->getName();
1151              }
1152          }
1153      }
1154      return tmp;
1155 }
1156
1157 void FGAIAircraft::handleATCRequests() {
1158     //TODO implement NullController for having no ATC to save the conditionals
1159     if (controller) {
1160         controller->updateAircraftInformation(getID(),
1161                                               pos.getLatitudeDeg(),
1162                                               pos.getLongitudeDeg(),
1163                                               hdg,
1164                                               speed,
1165                                               altitude_ft, dt);
1166         processATC(controller->getInstruction(getID()));
1167     }
1168 }
1169
1170 void FGAIAircraft::updateActualState() {
1171     //update current state
1172     //TODO have a single tgt_speed and check speed limit on ground on setting tgt_speed
1173     updatePosition();
1174
1175     if (onGround())
1176         speed = _performance->actualSpeed(this, groundTargetSpeed, dt);
1177     else
1178         speed = _performance->actualSpeed(this, (tgt_speed *speedFraction), dt);
1179
1180     updateHeading();
1181     roll = _performance->actualBankAngle(this, tgt_roll, dt);
1182
1183     // adjust altitude (meters) based on current vertical speed (fpm)
1184     altitude_ft += vs / 60.0 * dt;
1185     pos.setElevationFt(altitude_ft);
1186
1187     vs = _performance->actualVerticalSpeed(this, tgt_vs, dt);
1188     pitch = _performance->actualPitch(this, tgt_pitch, dt);
1189 }
1190
1191 void FGAIAircraft::updateSecondaryTargetValues() {
1192     // derived target state values
1193     updateBankAngleTarget();
1194     updateVerticalSpeedTarget();
1195     updatePitchAngleTarget();
1196
1197     //TODO calculate wind correction angle (tgt_yaw)
1198 }
1199
1200
1201 bool FGAIAircraft::reachedEndOfCruise(double &distance) {
1202     FGAIWaypoint* curr = fp->getCurrentWaypoint();
1203     if (curr->getName() == string("BOD")) {
1204         double dist = fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr);
1205         double descentSpeed = (getPerformance()->vDescent() * SG_NM_TO_METER) / 3600.0;     // convert from kts to meter/s
1206         double descentRate  = (getPerformance()->descentRate() * SG_FEET_TO_METER) / 60.0;  // convert from feet/min to meter/s
1207
1208         double verticalDistance  = ((altitude_ft - 2000.0) - trafficRef->getArrivalAirport()->getElevation()) *SG_FEET_TO_METER;
1209         double descentTimeNeeded = verticalDistance / descentRate;
1210         double distanceCovered   = descentSpeed * descentTimeNeeded;
1211
1212         //cerr << "Tracking  : " << fgGetString("/ai/track-callsign");
1213         if (trafficRef->getCallSign() == fgGetString("/ai/track-callsign")) {
1214             cerr << "Checking for end of cruise stage for :" << trafficRef->getCallSign() << endl;
1215             cerr << "Descent rate      : " << descentRate << endl;
1216             cerr << "Descent speed     : " << descentSpeed << endl;
1217             cerr << "VerticalDistance  : " << verticalDistance << ". Altitude : " << altitude_ft << ". Elevation " << trafficRef->getArrivalAirport()->getElevation() << endl;
1218             cerr << "DecentTimeNeeded  : " << descentTimeNeeded << endl;
1219             cerr << "DistanceCovered   : " << distanceCovered   << endl;
1220         }
1221         //cerr << "Distance = " << distance << endl;
1222         distance = distanceCovered;
1223         if (dist < distanceCovered) {
1224               if (trafficRef->getCallSign() == fgGetString("/ai/track-callsign")) {
1225                    //exit(1);
1226               }
1227               return true;
1228         } else {
1229               return false;
1230         }
1231     } else {
1232          return false;
1233     }
1234 }
1235
1236 void FGAIAircraft::resetPositionFromFlightPlan()
1237 {
1238     // the one behind you
1239     FGAIWaypoint* prev = 0;
1240     // the one ahead
1241     FGAIWaypoint* curr = 0;
1242     // the next plus 1
1243     FGAIWaypoint* next = 0;
1244
1245     prev = fp->getPreviousWaypoint();
1246     curr = fp->getCurrentWaypoint();
1247     next = fp->getNextWaypoint();
1248
1249     setLatitude(prev->getLatitude());
1250     setLongitude(prev->getLongitude());
1251     double tgt_heading = fp->getBearing(curr, next);
1252     setHeading(tgt_heading);
1253     setAltitude(prev->getAltitude());
1254     setSpeed(prev->getSpeed());
1255 }
1256
1257 double FGAIAircraft::getBearing(double crse)
1258 {
1259   double hdgDiff = fabs(hdg-crse);
1260   if (hdgDiff > 180)
1261       hdgDiff = fabs(hdgDiff - 360);
1262   return hdgDiff;
1263 }
1264
1265 time_t FGAIAircraft::checkForArrivalTime(string wptName) {
1266      FGAIWaypoint* curr = 0;
1267      curr = fp->getCurrentWaypoint();
1268
1269      double tracklength = fp->checkTrackLength(wptName);
1270      if (tracklength > 0.1) {
1271           tracklength += fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr);
1272      } else {
1273          return 0;
1274      }
1275      time_t now = time(NULL) + fgGetLong("/sim/time/warp");
1276      time_t arrivalTime = fp->getArrivalTime();
1277
1278      time_t ete = tracklength / ((speed * SG_NM_TO_METER) / 3600.0);
1279      time_t secondsToGo = arrivalTime - now;
1280      if (trafficRef->getCallSign() == fgGetString("/ai/track-callsign")) {
1281           cerr << "Checking arrival time: ete " << ete << ". Time to go : " << secondsToGo << ". Track length = " << tracklength << endl;
1282      }
1283      return (ete - secondsToGo); // Positive when we're too slow...
1284 }