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
  33 #include <string>
  34 #include <math.h>
  35 #include <time.h>
  36 #ifdef _MSC_VER
  37 #  include <float.h>
  38 #  define finite _finite
  39 #elif defined(__sun) || defined(sgi)
  40 #  include <ieeefp.h>
  41 #endif
  42
  43 using std::string;
  44
  45 #include "AIAircraft.hxx"
  46 #include "performancedata.hxx"
  47 #include "performancedb.hxx"
  48
  49 //#include <Airports/trafficcontroller.hxx>
  50
  51 static string tempReg;
  52
  53 class AI_OutOfSight{};
  54 class FP_Inactive{};
  55
  56 FGAIAircraft::FGAIAircraft(FGAISchedule *ref) : FGAIBase(otAircraft) {
  57     trafficRef = ref;
  58     if (trafficRef) {
  59         groundOffset = trafficRef->getGroundOffset();
  60         setCallSign(trafficRef->getCallSign());
  61     }
  62     else
  63         groundOffset = 0;
  64
  65     fp = 0;
  66     controller = 0;
  67     prevController = 0;
  68     dt_count = 0;
  69     dt_elev_count = 0;
  70     use_perf_vs = true;
  71
  72     no_roll = false;
  73     tgt_speed = 0;
  74     speed = 0;
  75     groundTargetSpeed = 0;
  76
  77     // set heading and altitude locks
  78     hdg_lock = false;
  79     alt_lock = false;
  80     roll = 0;
  81     headingChangeRate = 0.0;
  82
  83     holdPos = false;
  84
  85     _performance = 0; //TODO initialize to JET_TRANSPORT from PerformanceDB
  86
  87 }
  88
  89
  90 FGAIAircraft::~FGAIAircraft() {
  91     //delete fp;
  92     if (controller)
  93         controller->signOff(getID());
  94 }
  95
  96
  97 void FGAIAircraft::readFromScenario(SGPropertyNode* scFileNode) {
  98     if (!scFileNode)
  99         return;
 100
 101     FGAIBase::readFromScenario(scFileNode);
 102
 103     setPerformance(scFileNode->getStringValue("class", "jet_transport"));
 104     setFlightPlan(scFileNode->getStringValue("flightplan"),
 105                   scFileNode->getBoolValue("repeat", false));
 106     setCallSign(scFileNode->getStringValue("callsign"));
 107 }
 108
 109
 110 void FGAIAircraft::bind() {
 111     FGAIBase::bind();
 112
 113     props->tie("controls/gear/gear-down",
 114                SGRawValueMethods<FGAIAircraft,bool>(*this,
 115                                                     &FGAIAircraft::_getGearDown));
 116     props->tie("transponder-id",
 117                SGRawValueMethods<FGAIAircraft,const char*>(*this,
 118                                                     &FGAIAircraft::_getTransponderCode));
 119 }
 120
 121
 122 void FGAIAircraft::unbind() {
 123     FGAIBase::unbind();
 124
 125     props->untie("controls/gear/gear-down");
 126     props->untie("transponder-id");
 127 }
 128
 129
 130 void FGAIAircraft::update(double dt) {
 131     FGAIBase::update(dt);
 132     Run(dt);
 133     Transform();
 134 }
 135
 136 void FGAIAircraft::setPerformance(const std::string& acclass) {
 137      static PerformanceDB perfdb; //TODO make it a global service
 138      setPerformance(perfdb.getDataFor(acclass));
 139   }
 140
 141
 142  void FGAIAircraft::setPerformance(PerformanceData *ps) {
 143      _performance = ps;
 144   }
 145
 146
 147  void FGAIAircraft::Run(double dt) {
 148       FGAIAircraft::dt = dt;
 149
 150      try {
 151          updatePrimaryTargetValues(); // target hdg, alt, speed
 152      }
 153      catch (AI_OutOfSight) {
 154          return;
 155      }
 156      catch (FP_Inactive) {
 157          //return;
 158          groundTargetSpeed = 0;
 159      }
 160
 161      handleATCRequests(); // ATC also has a word to say
 162      updateSecondaryTargetValues(); // target roll, vertical speed, pitch
 163      updateActualState();
 164      UpdateRadar(manager);
 165      checkVisibility();
 166   }
 167
 168 void FGAIAircraft::checkVisibility()
 169 {
 170   double visibility_meters = fgGetDouble("/environment/visibility-m");
 171   FGViewer* vw = globals->get_current_view();
 172   invisible = (SGGeodesy::distanceM(vw->getPosition(), pos) > visibility_meters);
 173 }
 174
 175
 176
 177 void FGAIAircraft::AccelTo(double speed) {
 178     tgt_speed = speed;
 179 }
 180
 181
 182 void FGAIAircraft::PitchTo(double angle) {
 183     tgt_pitch = angle;
 184     alt_lock = false;
 185 }
 186
 187
 188 void FGAIAircraft::RollTo(double angle) {
 189     tgt_roll = angle;
 190     hdg_lock = false;
 191 }
 192
 193
 194 void FGAIAircraft::YawTo(double angle) {
 195     tgt_yaw = angle;
 196 }
 197
 198
 199 void FGAIAircraft::ClimbTo(double alt_ft ) {
 200     tgt_altitude_ft = alt_ft;
 201     alt_lock = true;
 202 }
 203
 204
 205 void FGAIAircraft::TurnTo(double heading) {
 206     tgt_heading = heading;
 207     hdg_lock = true;
 208 }
 209
 210
 211 double FGAIAircraft::sign(double x) {
 212     if (x == 0.0)
 213         return x;
 214     else
 215         return x/fabs(x);
 216 }
 217
 218
 219 void FGAIAircraft::setFlightPlan(const std::string& flightplan, bool repeat) {
 220     if (!flightplan.empty()) {
 221         FGAIFlightPlan* fp = new FGAIFlightPlan(flightplan);
 222         fp->setRepeat(repeat);
 223         SetFlightPlan(fp);
 224     }
 225 }
 226
 227
 228 void FGAIAircraft::SetFlightPlan(FGAIFlightPlan *f) {
 229     delete fp;
 230     fp = f;
 231 }
 232
 233
 234 void FGAIAircraft::ProcessFlightPlan( double dt, time_t now ) {
 235
 236     // the one behind you
 237     FGAIFlightPlan::waypoint* prev = 0;
 238     // the one ahead
 239     FGAIFlightPlan::waypoint* curr = 0;
 240     // the next plus 1
 241     FGAIFlightPlan::waypoint* next = 0;
 242
 243     prev = fp->getPreviousWaypoint();
 244     curr = fp->getCurrentWaypoint();
 245     next = fp->getNextWaypoint();
 246
 247     dt_count += dt;
 248
 249     ///////////////////////////////////////////////////////////////////////////
 250     // Initialize the flightplan
 251     //////////////////////////////////////////////////////////////////////////
 252     if (!prev) {
 253         handleFirstWaypoint();
 254         return;
 255     }                            // end of initialization
 256     if (! fpExecutable(now))
 257           return;
 258     dt_count = 0;
 259
 260     if (! leadPointReached(curr)) {
 261         controlHeading(curr);
 262         controlSpeed(curr, next);
 263     } else {
 264         if (curr->finished)      //end of the flight plan
 265         {
 266             if (fp->getRepeat())
 267                 fp->restart();
 268             else
 269                 setDie(true);
 270             return;
 271         }
 272
 273         if (next) {
 274             //TODO more intelligent method in AIFlightPlan, no need to send data it already has :-)
 275             tgt_heading = fp->getBearing(curr, next);
 276             spinCounter = 0;
 277         }
 278
 279         //TODO let the fp handle this (loading of next leg)
 280         fp->IncrementWaypoint((bool) trafficRef);
 281         if (!(fp->getNextWaypoint()) && trafficRef)
 282             if (!loadNextLeg()) {
 283                 setDie(true);
 284                 return;
 285             }
 286
 287         prev = fp->getPreviousWaypoint();
 288         curr = fp->getCurrentWaypoint();
 289         next = fp->getNextWaypoint();
 290
 291         // Now that we have incremented the waypoints, excute some traffic manager specific code
 292         if (trafficRef) {
 293             //TODO isn't this best executed right at the beginning?
 294             if (! aiTrafficVisible()) {
 295                 setDie(true);
 296                 return;
 297             }
 298
 299             if (! handleAirportEndPoints(prev, now)) {
 300                 setDie(true);
 301                 return;
 302             }
 303
 304             announcePositionToController();
 305
 306         }
 307
 308         if (next) {
 309             fp->setLeadDistance(tgt_speed, tgt_heading, curr, next);
 310         }
 311
 312         if (!(prev->on_ground))  // only update the tgt altitude from flightplan if not on the ground
 313         {
 314             tgt_altitude_ft = prev->altitude;
 315             if (curr->crossat > -1000.0) {
 316                 use_perf_vs = false;
 317                 tgt_vs = (curr->crossat - altitude_ft) / (fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr)
 318                          / 6076.0 / speed*60.0);
 319                 tgt_altitude_ft = curr->crossat;
 320             } else {
 321                 use_perf_vs = true;
 322             }
 323         }
 324         tgt_speed = prev->speed;
 325         hdg_lock = alt_lock = true;
 326         no_roll = prev->on_ground;
 327     }
 328 }
 329
 330
 331 void FGAIAircraft::initializeFlightPlan() {
 332 }
 333
 334
 335 bool FGAIAircraft::_getGearDown() const {
 336     return _performance->gearExtensible(this);
 337 }
 338
 339
 340 const char * FGAIAircraft::_getTransponderCode() const {
 341   return transponderCode.c_str();
 342 }
 343
 344
 345 bool FGAIAircraft::loadNextLeg() {
 346
 347     int leg;
 348     if ((leg = fp->getLeg())  == 10) {
 349         if (!trafficRef->next()) {
 350             return false;
 351         }
 352         setCallSign(trafficRef->getCallSign());
 353         leg = 1;
 354         fp->setLeg(leg);
 355     }
 356
 357     FGAirport *dep = trafficRef->getDepartureAirport();
 358     FGAirport *arr = trafficRef->getArrivalAirport();
 359     if (!(dep && arr)) {
 360         setDie(true);
 361
 362     } else {
 363         double cruiseAlt = trafficRef->getCruiseAlt() * 100;
 364
 365         fp->create (this,
 366                     dep,
 367                     arr,
 368                     leg,
 369                     cruiseAlt,
 370                     trafficRef->getSpeed(),
 371                     _getLatitude(),
 372                     _getLongitude(),
 373                     false,
 374                     trafficRef->getRadius(),
 375                     trafficRef->getFlightType(),
 376                     acType,
 377                     company);
 378        //cerr << "created  leg " << leg << " for " << trafficRef->getCallSign() << endl;
 379     }
 380     return true;
 381 }
 382
 383
 384 // Note: This code is copied from David Luff's AILocalTraffic
 385 // Warning - ground elev determination is CPU intensive
 386 // Either this function or the logic of how often it is called
 387 // will almost certainly change.
 388
 389 void FGAIAircraft::getGroundElev(double dt) {
 390     dt_elev_count += dt;
 391
 392     // Update minimally every three secs, but add some randomness
 393     // to prevent all AI objects doing this in synchrony
 394     if (dt_elev_count < (3.0) + (rand() % 10))
 395         return;
 396
 397     dt_elev_count = 0;
 398
 399     // Only do the proper hitlist stuff if we are within visible range of the viewer.
 400     if (!invisible) {
 401         double visibility_meters = fgGetDouble("/environment/visibility-m");
 402         FGViewer* vw = globals->get_current_view();
 403
 404         if (SGGeodesy::distanceM(vw->getPosition(), pos) > visibility_meters) {
 405             return;
 406         }
 407
 408         double range = 500.0;
 409         if (!globals->get_tile_mgr()->scenery_available(pos, range)) {
 410             // Try to shedule tiles for that position.
 411             globals->get_tile_mgr()->update( pos, range );
 412         }
 413
 414         double alt;
 415         if (globals->get_scenery()->get_elevation_m(SGGeod::fromGeodM(pos, 20000), alt, 0))
 416             tgt_altitude_ft = alt * SG_METER_TO_FEET;
 417     }
 418 }
 419
 420
 421 void FGAIAircraft::doGroundAltitude() {
 422     if (fabs(altitude_ft - (tgt_altitude_ft+groundOffset)) > 1000.0)
 423         altitude_ft = (tgt_altitude_ft + groundOffset);
 424     else
 425         altitude_ft += 0.1 * ((tgt_altitude_ft+groundOffset) - altitude_ft);
 426 }
 427
 428
 429 void FGAIAircraft::announcePositionToController() {
 430     if (trafficRef) {
 431         int leg = fp->getLeg();
 432
 433         // Note that leg has been incremented after creating the current leg, so we should use
 434         // leg numbers here that are one higher than the number that is used to create the leg
 435         //
 436         switch (leg) {
 437           case 2:              // Startup and Push back
 438             if (trafficRef->getDepartureAirport()->getDynamics())
 439                 controller = trafficRef->getDepartureAirport()->getDynamics()->getStartupController();
 440             break;
 441         case 3:              // Taxiing to runway
 442             if (trafficRef->getDepartureAirport()->getDynamics()->getGroundNetwork()->exists())
 443                 controller = trafficRef->getDepartureAirport()->getDynamics()->getGroundNetwork();
 444             break;
 445         case 4:              //Take off tower controller
 446             if (trafficRef->getDepartureAirport()->getDynamics()) {
 447                 controller = trafficRef->getDepartureAirport()->getDynamics()->getTowerController();
 448                 //if (trafficRef->getDepartureAirport()->getId() == "EHAM") {
 449                 //string trns = trafficRef->getCallSign() + " at runway " + fp->getRunway() +
 450                 //              ". Ready for departure. " + trafficRef->getFlightType() + " to " +
 451                 //              trafficRef->getArrivalAirport()->getId();
 452                 //fgSetString("/sim/messages/atc", trns.c_str());
 453                 //  if (controller == 0) {
 454                 //cerr << "Error in assigning controller at " << trafficRef->getDepartureAirport()->getId() << endl;
 455                 //}
 456                 //}
 457             } else {
 458                 cerr << "Error: Could not find Dynamics at airport : " << trafficRef->getDepartureAirport()->getId() << endl;
 459             }
 460             break;
 461         case 9:              // Taxiing for parking
 462             if (trafficRef->getArrivalAirport()->getDynamics()->getGroundNetwork()->exists())
 463                 controller = trafficRef->getArrivalAirport()->getDynamics()->getGroundNetwork();
 464             break;
 465         default:
 466             controller = 0;
 467             break;
 468         }
 469
 470         if ((controller != prevController) && (prevController != 0)) {
 471             prevController->signOff(getID());
 472         }
 473         prevController = controller;
 474         if (controller) {
 475             controller->announcePosition(getID(), fp, fp->getCurrentWaypoint()->routeIndex,
 476                                          _getLatitude(), _getLongitude(), hdg, speed, altitude_ft,
 477                                          trafficRef->getRadius(), leg, this);
 478         }
 479     }
 480 }
 481
 482 // Process ATC instructions and report back
 483
 484 void FGAIAircraft::processATC(FGATCInstruction instruction) {
 485     if (instruction.getCheckForCircularWait()) {
 486         // This is not exactly an elegant solution,
 487         // but at least it gives me a chance to check
 488         // if circular waits are resolved.
 489         // For now, just take the offending aircraft
 490         // out of the scene
 491         setDie(true);
 492         // a more proper way should be - of course - to
 493         // let an offending aircraft take an evasive action
 494         // for instance taxi back a little bit.
 495     }
 496     //cerr << "Processing ATC instruction (not Implimented yet)" << endl;
 497     if (instruction.getHoldPattern   ()) {}
 498
 499     // Hold Position
 500     if (instruction.getHoldPosition  ()) {
 501         if (!holdPos) {
 502             holdPos = true;
 503         }
 504         AccelTo(0.0);
 505     } else {
 506         if (holdPos) {
 507             //if (trafficRef)
 508             //  cerr << trafficRef->getCallSign() << " Resuming Taxi." << endl;
 509             holdPos = false;
 510         }
 511         // Change speed Instruction. This can only be excecuted when there is no
 512         // Hold position instruction.
 513         if (instruction.getChangeSpeed   ()) {
 514             //  if (trafficRef)
 515             //cerr << trafficRef->getCallSign() << " Changing Speed " << endl;
 516             AccelTo(instruction.getSpeed());
 517         } else {
 518             if (fp) AccelTo(fp->getPreviousWaypoint()->speed);
 519         }
 520     }
 521     if (instruction.getChangeHeading ()) {
 522         hdg_lock = false;
 523         TurnTo(instruction.getHeading());
 524     } else {
 525         if (fp) {
 526             hdg_lock = true;
 527         }
 528     }
 529     if (instruction.getChangeAltitude()) {}
 530
 531 }
 532
 533
 534 void FGAIAircraft::handleFirstWaypoint() {
 535     bool eraseWaypoints;         //TODO YAGNI
 536     headingError = 0;
 537     if (trafficRef) {
 538         eraseWaypoints = true;
 539     } else {
 540         eraseWaypoints = false;
 541     }
 542
 543     FGAIFlightPlan::waypoint* prev = 0; // the one behind you
 544     FGAIFlightPlan::waypoint* curr = 0; // the one ahead
 545     FGAIFlightPlan::waypoint* next = 0;// the next plus 1
 546
 547     spinCounter = 0;
 548     tempReg = "";
 549
 550     //TODO fp should handle this
 551     fp->IncrementWaypoint(eraseWaypoints);
 552     if (!(fp->getNextWaypoint()) && trafficRef)
 553         if (!loadNextLeg()) {
 554             setDie(true);
 555             return;
 556         }
 557
 558     prev = fp->getPreviousWaypoint();   //first waypoint
 559     curr = fp->getCurrentWaypoint();    //second waypoint
 560     next = fp->getNextWaypoint();       //third waypoint (might not exist!)
 561
 562     setLatitude(prev->latitude);
 563     setLongitude(prev->longitude);
 564     setSpeed(prev->speed);
 565     setAltitude(prev->altitude);
 566
 567     if (prev->speed > 0.0)
 568         setHeading(fp->getBearing(prev->latitude, prev->longitude, curr));
 569     else
 570         setHeading(fp->getBearing(curr->latitude, curr->longitude, prev));
 571
 572     // If next doesn't exist, as in incrementally created flightplans for
 573     // AI/Trafficmanager created plans,
 574     // Make sure lead distance is initialized otherwise
 575     if (next)
 576         fp->setLeadDistance(speed, hdg, curr, next);
 577
 578     if (curr->crossat > -1000.0) //use a calculated descent/climb rate
 579     {
 580         use_perf_vs = false;
 581         tgt_vs = (curr->crossat - prev->altitude)
 582                  / (fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr)
 583                     / 6076.0 / prev->speed*60.0);
 584         tgt_altitude_ft = curr->crossat;
 585     } else {
 586         use_perf_vs = true;
 587         tgt_altitude_ft = prev->altitude;
 588     }
 589     alt_lock = hdg_lock = true;
 590     no_roll = prev->on_ground;
 591     if (no_roll) {
 592         Transform();             // make sure aip is initialized.
 593         getGroundElev(60.1);     // make sure it's executed first time around, so force a large dt value
 594         doGroundAltitude();
 595     }
 596     // Make sure to announce the aircraft's position
 597     announcePositionToController();
 598     prevSpeed = 0;
 599 }
 600
 601
 602 /**
 603  * Check Execution time (currently once every 100 ms)
 604  * Add a bit of randomization to prevent the execution of all flight plans
 605  * in synchrony, which can add significant periodic framerate flutter.
 606  *
 607  * @param now
 608  * @return
 609  */
 610 bool FGAIAircraft::fpExecutable(time_t now) {
 611     double rand_exec_time = (rand() % 100) / 100;
 612     return (dt_count > (0.1+rand_exec_time)) && (fp->isActive(now));
 613 }
 614
 615
 616 /**
 617  * Check to see if we've reached the lead point for our next turn
 618  *
 619  * @param curr
 620  * @return
 621  */
 622 bool FGAIAircraft::leadPointReached(FGAIFlightPlan::waypoint* curr) {
 623     double dist_to_go = fp->getDistanceToGo(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr);
 624
 625     //cerr << "2" << endl;
 626     double lead_dist = fp->getLeadDistance();
 627     // experimental: Use fabs, because speed can be negative (I hope) during push_back.
 628
 629     if (lead_dist < fabs(2*speed)) {
 630       //don't skip over the waypoint
 631       lead_dist = fabs(2*speed);
 632       //cerr << "Extending lead distance to " << lead_dist << endl;
 633     }
 634
 635     //prev_dist_to_go = dist_to_go;
 636     //if (dist_to_go < lead_dist)
 637     //     cerr << trafficRef->getCallSign() << " Distance : "
 638     //          << dist_to_go << ": Lead distance "
 639     //          << lead_dist << " " << curr->name
 640     //          << " Ground target speed " << groundTargetSpeed << endl;
 641
 642     return dist_to_go < lead_dist;
 643 }
 644
 645
 646 bool FGAIAircraft::aiTrafficVisible() {
 647   SGGeod userPos(SGGeod::fromDeg(fgGetDouble("/position/longitude-deg"),
 648     fgGetDouble("/position/latitude-deg")));
 649
 650   return (SGGeodesy::distanceNm(userPos, pos) <= TRAFFICTOAIDISTTODIE);
 651 }
 652
 653
 654 /**
 655  * Handle release of parking gate, once were taxiing. Also ensure service time at the gate
 656  * in the case of an arrival.
 657  *
 658  * @param prev
 659  * @return
 660  */
 661
 662 //TODO the trafficRef is the right place for the method
 663 bool FGAIAircraft::handleAirportEndPoints(FGAIFlightPlan::waypoint* prev, time_t now) {
 664     // prepare routing from one airport to another
 665     FGAirport * dep = trafficRef->getDepartureAirport();
 666     FGAirport * arr = trafficRef->getArrivalAirport();
 667
 668     if (!( dep && arr))
 669         return false;
 670
 671     // This waypoint marks the fact that the aircraft has passed the initial taxi
 672     // departure waypoint, so it can release the parking.
 673     //cerr << trafficRef->getCallSign() << " has passed waypoint " << prev->name << " at speed " << speed << endl;
 674     if (prev->name == "PushBackPoint") {
 675         dep->getDynamics()->releaseParking(fp->getGate());
 676         time_t holdUntil = now + 120;
 677         fp->setTime(holdUntil);
 678         //cerr << _getCallsign() << "Holding at pushback point" << endl;
 679     }
 680
 681     // This is the last taxi waypoint, and marks the the end of the flight plan
 682     // so, the schedule should update and wait for the next departure time.
 683     if (prev->name == "END") {
 684         time_t nextDeparture = trafficRef->getDepartureTime();
 685         // make sure to wait at least 20 minutes at parking to prevent "nervous" taxi behavior
 686         if (nextDeparture < (now+1200)) {
 687             nextDeparture = now + 1200;
 688         }
 689         fp->setTime(nextDeparture); // should be "next departure"
 690     }
 691
 692     return true;
 693 }
 694
 695
 696 /**
 697  * Check difference between target bearing and current heading and correct if necessary.
 698  *
 699  * @param curr
 700  */
 701 void FGAIAircraft::controlHeading(FGAIFlightPlan::waypoint* curr) {
 702     double calc_bearing = fp->getBearing(pos.getLatitudeDeg(), pos.getLongitudeDeg(), curr);
 703     //cerr << "Bearing = " << calc_bearing << endl;
 704     if (speed < 0) {
 705         calc_bearing +=180;
 706         if (calc_bearing > 360)
 707             calc_bearing -= 360;
 708     }
 709
 710     if (finite(calc_bearing)) {
 711         double hdg_error = calc_bearing - tgt_heading;
 712         if (fabs(hdg_error) > 0.01) {
 713             TurnTo( calc_bearing );
 714         }
 715
 716     } else {
 717         cerr << "calc_bearing is not a finite number : "
 718         << "Speed " << speed
 719         << "pos : " << pos.getLatitudeDeg() << ", " << pos.getLongitudeDeg()
 720         << "waypoint " << curr->latitude << ", " << curr->longitude << endl;
 721         cerr << "waypoint name " << curr->name;
 722         exit(1);                 // FIXME
 723     }
 724 }
 725
 726
 727 /**
 728  * Update the lead distance calculation if speed has changed sufficiently
 729  * to prevent spinning (hopefully);
 730  *
 731  * @param curr
 732  * @param next
 733  */
 734 void FGAIAircraft::controlSpeed(FGAIFlightPlan::waypoint* curr, FGAIFlightPlan::waypoint* next) {
 735     double speed_diff = speed - prevSpeed;
 736
 737     if (fabs(speed_diff) > 10) {
 738         prevSpeed = speed;
 739         if (next) {
 740             fp->setLeadDistance(speed, tgt_heading, curr, next);
 741         }
 742     }
 743 }
 744
 745
 746 /**
 747  * Update target values (heading, alt, speed) depending on flight plan or control properties
 748  */
 749 void FGAIAircraft::updatePrimaryTargetValues() {
 750     if (fp)                      // AI object has a flightplan
 751     {
 752         //TODO make this a function of AIBase
 753         time_t now = time(NULL) + fgGetLong("/sim/time/warp");
 754         //cerr << "UpateTArgetValues() " << endl;
 755         ProcessFlightPlan(dt, now);
 756
 757         // Do execute Ground elev for inactive aircraft, so they
 758         // Are repositioned to the correct ground altitude when the user flies within visibility range.
 759         // In addition, check whether we are out of user range, so this aircraft
 760         // can be deleted.
 761         if (onGround()) {
 762                 Transform();     // make sure aip is initialized.
 763                 getGroundElev(dt);
 764                 doGroundAltitude();
 765                 // Transform();
 766                 pos.setElevationFt(altitude_ft);
 767         }
 768         if (trafficRef) {
 769            //cerr << trafficRef->getRegistration() << " Setting altitude to " << altitude_ft;
 770             if (! aiTrafficVisible()) {
 771                 setDie(true);
 772                 //cerr << trafficRef->getRegistration() << " is set to die " << endl;
 773                 throw AI_OutOfSight();
 774             }
 775         }
 776         timeElapsed = now - fp->getStartTime();
 777         if (! fp->isActive(now)) {
 778             throw FP_Inactive();
 779         }
 780     } else {
 781         // no flight plan, update target heading, speed, and altitude
 782         // from control properties.  These default to the initial
 783         // settings in the config file, but can be changed "on the
 784         // fly".
 785         string lat_mode = props->getStringValue("controls/flight/lateral-mode");
 786         if ( lat_mode == "roll" ) {
 787             double angle
 788             = props->getDoubleValue("controls/flight/target-roll" );
 789             RollTo( angle );
 790         } else {
 791             double angle
 792             = props->getDoubleValue("controls/flight/target-hdg" );
 793             TurnTo( angle );
 794         }
 795
 796         string lon_mode
 797         = props->getStringValue("controls/flight/longitude-mode");
 798         if ( lon_mode == "alt" ) {
 799             double alt = props->getDoubleValue("controls/flight/target-alt" );
 800             ClimbTo( alt );
 801         } else {
 802             double angle
 803             = props->getDoubleValue("controls/flight/target-pitch" );
 804             PitchTo( angle );
 805         }
 806
 807         AccelTo( props->getDoubleValue("controls/flight/target-spd" ) );
 808     }
 809 }
 810
 811 void FGAIAircraft::updatePosition() {
 812     // convert speed to degrees per second
 813     double speed_north_deg_sec = cos( hdg * SGD_DEGREES_TO_RADIANS )
 814                                  * speed * 1.686 / ft_per_deg_lat;
 815     double speed_east_deg_sec  = sin( hdg * SGD_DEGREES_TO_RADIANS )
 816                                  * speed * 1.686 / ft_per_deg_lon;
 817
 818     // set new position
 819     pos.setLatitudeDeg( pos.getLatitudeDeg() + speed_north_deg_sec * dt);
 820     pos.setLongitudeDeg( pos.getLongitudeDeg() + speed_east_deg_sec * dt);
 821 }
 822
 823
 824 void FGAIAircraft::updateHeading() {
 825     // adjust heading based on current bank angle
 826     if (roll == 0.0)
 827         roll = 0.01;
 828
 829     if (roll != 0.0) {
 830         // double turnConstant;
 831         //if (no_roll)
 832         //  turnConstant = 0.0088362;
 833         //else
 834         //  turnConstant = 0.088362;
 835         // If on ground, calculate heading change directly
 836         if (onGround()) {
 837             double headingDiff = fabs(hdg-tgt_heading);
 838             double bank_sense = 0.0;
 839         /*
 840         double diff = fabs(hdg - tgt_heading);
 841         if (diff > 180)
 842             diff = fabs(diff - 360);
 843
 844         double sum = hdg + diff;
 845         if (sum > 360.0)
 846             sum -= 360.0;
 847         if (fabs(sum - tgt_heading) < 1.0) {
 848             bank_sense = 1.0;    // right turn
 849         } else {
 850             bank_sense = -1.0;   // left turn
 851         }*/
 852             if (headingDiff > 180)
 853                 headingDiff = fabs(headingDiff - 360);
 854             double sum = hdg + headingDiff;
 855             if (sum > 360.0)
 856                 sum -= 360.0;
 857             if (fabs(sum - tgt_heading) > 0.0001) {
 858                 bank_sense = -1.0;
 859             } else {
 860                 bank_sense = 1.0;
 861             }
 862             //if (trafficRef)
 863                 //cerr << trafficRef->getCallSign() << " Heading "
 864                 //     << hdg << ". Target " << tgt_heading <<  ". Diff " << fabs(sum - tgt_heading) << ". Speed " << speed << endl;
 865             //if (headingDiff > 60) {
 866             groundTargetSpeed = tgt_speed; // * cos(headingDiff * SG_DEGREES_TO_RADIANS);
 867                 //groundTargetSpeed = tgt_speed - tgt_speed * (headingDiff/180);
 868             //} else {
 869             //    groundTargetSpeed = tgt_speed;
 870             //}
 871             if (sign(groundTargetSpeed) != sign(tgt_speed))
 872                 groundTargetSpeed = 0.21 * sign(tgt_speed); // to prevent speed getting stuck in 'negative' mode
 873
 874             if (headingDiff > 30.0) {
 875                 // invert if pushed backward
 876                 headingChangeRate += 10.0 * dt * sign(roll);
 877
 878                 // Clamp the maximum steering rate to 30 degrees per second,
 879                 // But only do this when the heading error is decreasing.
 880                 if ((headingDiff < headingError)) {
 881                     if (headingChangeRate > 30)
 882                         headingChangeRate = 30;
 883                     else if (headingChangeRate < -30)
 884                         headingChangeRate = -30;
 885                 }
 886             } else {
 887                    if (fabs(headingChangeRate) > headingDiff)
 888                        headingChangeRate = headingDiff*sign(roll);
 889                    else
 890                        headingChangeRate += dt * sign(roll);
 891             }
 892
 893             hdg += headingChangeRate * dt * (fabs(speed) / 15);
 894             headingError = headingDiff;
 895         } else {
 896             if (fabs(speed) > 1.0) {
 897                 turn_radius_ft = 0.088362 * speed * speed
 898                                  / tan( fabs(roll) / SG_RADIANS_TO_DEGREES );
 899             } else {
 900                 // Check if turn_radius_ft == 0; this might lead to a division by 0.
 901                 turn_radius_ft = 1.0;
 902             }
 903             double turn_circum_ft = SGD_2PI * turn_radius_ft;
 904             double dist_covered_ft = speed * 1.686 * dt;
 905             double alpha = dist_covered_ft / turn_circum_ft * 360.0;
 906             hdg += alpha * sign(roll);
 907         }
 908         while ( hdg > 360.0 ) {
 909             hdg -= 360.0;
 910             spinCounter++;
 911         }
 912         while ( hdg < 0.0) {
 913             hdg += 360.0;
 914             spinCounter--;
 915         }
 916     }
 917 }
 918
 919
 920 void FGAIAircraft::updateBankAngleTarget() {
 921     // adjust target bank angle if heading lock engaged
 922     if (hdg_lock) {
 923         double bank_sense = 0.0;
 924         double diff = fabs(hdg - tgt_heading);
 925         if (diff > 180)
 926             diff = fabs(diff - 360);
 927
 928         double sum = hdg + diff;
 929         if (sum > 360.0)
 930             sum -= 360.0;
 931         if (fabs(sum - tgt_heading) < 1.0) {
 932             bank_sense = 1.0;    // right turn
 933         } else {
 934             bank_sense = -1.0;   // left turn
 935         }
 936         if (diff < _performance->maximumBankAngle()) {
 937             tgt_roll = diff * bank_sense;
 938         } else {
 939             tgt_roll = _performance->maximumBankAngle() * bank_sense;
 940         }
 941         if ((fabs((double) spinCounter) > 1) && (diff > _performance->maximumBankAngle())) {
 942             tgt_speed *= 0.999;  // Ugly hack: If aircraft get stuck, they will continually spin around.
 943             // The only way to resolve this is to make them slow down.
 944         }
 945     }
 946 }
 947
 948
 949 void FGAIAircraft::updateVerticalSpeedTarget() {
 950     // adjust target Altitude, based on ground elevation when on ground
 951     if (onGround()) {
 952         getGroundElev(dt);
 953         doGroundAltitude();
 954     } else if (alt_lock) {
 955         // find target vertical speed
 956         if (use_perf_vs) {
 957             if (altitude_ft < tgt_altitude_ft) {
 958                 tgt_vs = tgt_altitude_ft - altitude_ft;
 959                 if (tgt_vs > _performance->climbRate())
 960                     tgt_vs = _performance->climbRate();
 961             } else {
 962                 tgt_vs = tgt_altitude_ft - altitude_ft;
 963                 if (tgt_vs  < (-_performance->descentRate()))
 964                     tgt_vs = -_performance->descentRate();
 965             }
 966         } else {
 967             double max_vs = 4*(tgt_altitude_ft - altitude_ft);
 968             double min_vs = 100;
 969             if (tgt_altitude_ft < altitude_ft)
 970                 min_vs = -100.0;
 971             if ((fabs(tgt_altitude_ft - altitude_ft) < 1500.0)
 972                     && (fabs(max_vs) < fabs(tgt_vs)))
 973                 tgt_vs = max_vs;
 974
 975             if (fabs(tgt_vs) < fabs(min_vs))
 976                 tgt_vs = min_vs;
 977         }
 978     } //else
 979     //    tgt_vs = 0.0;
 980 }
 981
 982 void FGAIAircraft::updatePitchAngleTarget() {
 983     // if on ground and above vRotate -> initial rotation
 984     if (onGround() && (speed > _performance->vRotate()))
 985         tgt_pitch = 8.0; // some rough B737 value
 986
 987     //TODO pitch angle on approach and landing
 988
 989     // match pitch angle to vertical speed
 990     else if (tgt_vs > 0) {
 991         tgt_pitch = tgt_vs * 0.005;
 992     } else {
 993         tgt_pitch = tgt_vs * 0.002;
 994     }
 995 }
 996
 997 string FGAIAircraft::atGate() {
 998      string tmp("");
 999      if (fp->getLeg() < 3) {
1000          if (trafficRef) {
1001              if (fp->getGate() > 0) {
1002                  FGParking *park =
1003                      trafficRef->getDepartureAirport()->getDynamics()->getParking(fp->getGate());
1004                  tmp = park->getName();
1005              }
1006          }
1007      }
1008      return tmp;
1009 }
1010
1011 void FGAIAircraft::handleATCRequests() {
1012     //TODO implement NullController for having no ATC to save the conditionals
1013     if (controller) {
1014         controller->update(getID(),
1015                            pos.getLatitudeDeg(),
1016                            pos.getLongitudeDeg(),
1017                            hdg,
1018                            speed,
1019                            altitude_ft, dt);
1020         processATC(controller->getInstruction(getID()));
1021     }
1022 }
1023
1024 void FGAIAircraft::updateActualState() {
1025     //update current state
1026     //TODO have a single tgt_speed and check speed limit on ground on setting tgt_speed
1027     updatePosition();
1028
1029     if (onGround())
1030         speed = _performance->actualSpeed(this, groundTargetSpeed, dt);
1031     else
1032         speed = _performance->actualSpeed(this, tgt_speed, dt);
1033
1034     updateHeading();
1035     roll = _performance->actualBankAngle(this, tgt_roll, dt);
1036
1037     // adjust altitude (meters) based on current vertical speed (fpm)
1038     altitude_ft += vs / 60.0 * dt;
1039     pos.setElevationFt(altitude_ft);
1040
1041     vs = _performance->actualVerticalSpeed(this, tgt_vs, dt);
1042     pitch = _performance->actualPitch(this, tgt_pitch, dt);
1043 }
1044
1045 void FGAIAircraft::updateSecondaryTargetValues() {
1046     // derived target state values
1047     updateBankAngleTarget();
1048     updateVerticalSpeedTarget();
1049     updatePitchAngleTarget();
1050
1051     //TODO calculate wind correction angle (tgt_yaw)
1052 }