src/FDM/JSBSim/FGFDMExec.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGFDMExec.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 11/17/98
   6  Purpose:      Schedules and runs the model routines.
   7
   8  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU Lesser General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU Lesser General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU Lesser General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29
  30 This class wraps up the simulation scheduling routines.
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 11/17/98   JSB   Created
  35
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 COMMENTS, REFERENCES,  and NOTES
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  39
  40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  41 INCLUDES
  42 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  43
  44 #include "FGFDMExec.h"
  45 #include "FGState.h"
  46 #include <models/FGAtmosphere.h>
  47 #include <models/atmosphere/FGMSIS.h>
  48 #include <models/atmosphere/FGMars.h>
  49 #include <models/FGFCS.h>
  50 #include <models/FGPropulsion.h>
  51 #include <models/FGMassBalance.h>
  52 #include <models/FGGroundReactions.h>
  53 #include <models/FGExternalReactions.h>
  54 #include <models/FGBuoyantForces.h>
  55 #include <models/FGAerodynamics.h>
  56 #include <models/FGInertial.h>
  57 #include <models/FGAircraft.h>
  58 #include <models/FGPropagate.h>
  59 #include <models/FGAuxiliary.h>
  60 #include <models/FGInput.h>
  61 #include <models/FGOutput.h>
  62 #include <initialization/FGInitialCondition.h>
  63 //#include <initialization/FGTrimAnalysis.h> // Remove until later
  64 #include <input_output/FGPropertyManager.h>
  65 #include <input_output/FGScript.h>
  66
  67 #include <iostream>
  68 #include <iterator>
  69
  70 namespace JSBSim {
  71
  72 static const char *IdSrc = "$Id$";
  73 static const char *IdHdr = ID_FDMEXEC;
  74
  75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 GLOBAL DECLARATIONS
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  78
  79 unsigned int FGFDMExec::FDMctr = 0;
  80 FGPropertyManager* FGFDMExec::master=0;
  81
  82 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  83 CLASS IMPLEMENTATION
  84 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  85
  86 void checkTied ( FGPropertyManager *node )
  87 {
  88   int N = node->nChildren();
  89   string name;
  90
  91   for (int i=0; i<N; i++) {
  92     if (node->getChild(i)->nChildren() ) {
  93       checkTied( (FGPropertyManager*)node->getChild(i) );
  94     } else if ( node->getChild(i)->isTied() ) {
  95       name = ((FGPropertyManager*)node->getChild(i))->GetFullyQualifiedName();
  96       node->Untie(name);
  97     }
  98   }
  99 }
 100
 101 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 102 // Constructor
 103
 104 FGFDMExec::FGFDMExec(FGPropertyManager* root) : Root(root)
 105 {
 106
 107   Frame           = 0;
 108   FirstModel      = 0;
 109   Error           = 0;
 110   GroundCallback  = 0;
 111   State           = 0;
 112   Atmosphere      = 0;
 113   FCS             = 0;
 114   Propulsion      = 0;
 115   MassBalance     = 0;
 116   Aerodynamics    = 0;
 117   Inertial        = 0;
 118   GroundReactions = 0;
 119   ExternalReactions = 0;
 120   BuoyantForces   = 0;
 121   Aircraft        = 0;
 122   Propagate       = 0;
 123   Auxiliary       = 0;
 124   Input           = 0;
 125   IC              = 0;
 126   Trim            = 0;
 127   Script          = 0;
 128
 129   modelLoaded = false;
 130   IsChild = false;
 131   holding = false;
 132   Terminate = false;
 133
 134   IdFDM = FDMctr; // The main (parent) JSBSim instance is always the "zeroth"
 135   FDMctr++;       // instance. "child" instances are loaded last.
 136
 137   try {
 138     char* num = getenv("JSBSIM_DEBUG");
 139     if (num) debug_lvl = atoi(num); // set debug level
 140   } catch (...) {               // if error set to 1
 141     debug_lvl = 1;
 142   }
 143
 144   if (Root == 0) {
 145     if (master == 0)
 146       master = new FGPropertyManager;
 147     Root = master;
 148   }
 149
 150   instance = Root->GetNode("/fdm/jsbsim",IdFDM,true);
 151   Debug(0);
 152   // this is to catch errors in binding member functions to the property tree.
 153   try {
 154     Allocate();
 155   } catch ( string msg ) {
 156     cout << "Caught error: " << msg << endl;
 157     exit(1);
 158   }
 159
 160   trim_status = false;
 161   ta_mode     = 99;
 162
 163   Constructing = true;
 164   typedef int (FGFDMExec::*iPMF)(void) const;
 165 //  instance->Tie("simulation/do_trim_analysis", this, (iPMF)0, &FGFDMExec::DoTrimAnalysis);
 166   instance->Tie("simulation/do_simple_trim", this, (iPMF)0, &FGFDMExec::DoTrim);
 167   instance->Tie("simulation/reset", this, (iPMF)0, &FGFDMExec::ResetToInitialConditions);
 168   instance->Tie("simulation/terminate", (int *)&Terminate);
 169   Constructing = false;
 170 }
 171
 172 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 173
 174 FGFDMExec::~FGFDMExec()
 175 {
 176   try {
 177     checkTied( instance );
 178     DeAllocate();
 179     if (Root == 0)  delete master;
 180   } catch ( string msg ) {
 181     cout << "Caught error: " << msg << endl;
 182   }
 183
 184   for (unsigned int i=1; i<ChildFDMList.size(); i++) delete ChildFDMList[i]->exec;
 185   ChildFDMList.clear();
 186
 187   PropertyCatalog.clear();
 188
 189   FDMctr--;
 190
 191   Debug(1);
 192 }
 193
 194 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 195
 196 bool FGFDMExec::Allocate(void)
 197 {
 198   bool result=true;
 199
 200   Atmosphere      = new FGAtmosphere(this);
 201   FCS             = new FGFCS(this);
 202   Propulsion      = new FGPropulsion(this);
 203   MassBalance     = new FGMassBalance(this);
 204   Aerodynamics    = new FGAerodynamics (this);
 205   Inertial        = new FGInertial(this);
 206
 207   GroundCallback  = new FGGroundCallback(Inertial->GetRefRadius());
 208
 209   GroundReactions = new FGGroundReactions(this);
 210   ExternalReactions = new FGExternalReactions(this);
 211   BuoyantForces   = new FGBuoyantForces(this);
 212   Aircraft        = new FGAircraft(this);
 213   Propagate       = new FGPropagate(this);
 214   Auxiliary       = new FGAuxiliary(this);
 215   Input           = new FGInput(this);
 216
 217   State           = new FGState(this); // This must be done here, as the FGState
 218                                        // class needs valid pointers to the above
 219                                        // model classes
 220
 221   // Initialize models so they can communicate with each other
 222
 223   Atmosphere->InitModel();
 224   FCS->InitModel();
 225   Propulsion->InitModel();
 226   MassBalance->InitModel();
 227   Aerodynamics->InitModel();
 228   Inertial->InitModel();
 229   GroundReactions->InitModel();
 230   ExternalReactions->InitModel();
 231   BuoyantForces->InitModel();
 232   Aircraft->InitModel();
 233   Propagate->InitModel();
 234   Auxiliary->InitModel();
 235   Input->InitModel();
 236
 237   IC = new FGInitialCondition(this);
 238
 239   // Schedule a model. The second arg (the integer) is the pass number. For
 240   // instance, the atmosphere model could get executed every fifth pass it is called
 241   // by the executive. IC and Trim objects are NOT scheduled.
 242
 243   Schedule(Input,           1);
 244   Schedule(Atmosphere,      1);
 245   Schedule(FCS,             1);
 246   Schedule(Propulsion,      1);
 247   Schedule(MassBalance,     1);
 248   Schedule(Aerodynamics,    1);
 249   Schedule(Inertial,        1);
 250   Schedule(GroundReactions, 1);
 251   Schedule(ExternalReactions, 1);
 252   Schedule(BuoyantForces,   1);
 253   Schedule(Aircraft,        1);
 254   Schedule(Propagate,       1);
 255   Schedule(Auxiliary,       1);
 256
 257   modelLoaded = false;
 258
 259   return result;
 260 }
 261
 262 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 263
 264 bool FGFDMExec::DeAllocate(void)
 265 {
 266   delete Input;
 267   delete Atmosphere;
 268   delete FCS;
 269   delete Propulsion;
 270   delete MassBalance;
 271   delete Aerodynamics;
 272   delete Inertial;
 273   delete GroundReactions;
 274   delete ExternalReactions;
 275   delete BuoyantForces;
 276   delete Aircraft;
 277   delete Propagate;
 278   delete Auxiliary;
 279   delete State;
 280   delete Script;
 281
 282   for (unsigned i=0; i<Outputs.size(); i++) delete Outputs[i];
 283   Outputs.clear();
 284
 285   delete IC;
 286   delete Trim;
 287
 288   delete GroundCallback;
 289
 290   FirstModel  = 0L;
 291   Error       = 0;
 292
 293   State           = 0;
 294   Input           = 0;
 295   Atmosphere      = 0;
 296   FCS             = 0;
 297   Propulsion      = 0;
 298   MassBalance     = 0;
 299   Aerodynamics    = 0;
 300   Inertial        = 0;
 301   GroundReactions = 0;
 302   ExternalReactions = 0;
 303   BuoyantForces   = 0;
 304   Aircraft        = 0;
 305   Propagate       = 0;
 306   Auxiliary       = 0;
 307   Script          = 0;
 308
 309   modelLoaded = false;
 310   return modelLoaded;
 311 }
 312
 313 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 314
 315 int FGFDMExec::Schedule(FGModel* model, int rate)
 316 {
 317   FGModel* model_iterator;
 318
 319   model_iterator = FirstModel;
 320
 321   if (model_iterator == 0L) {                  // this is the first model
 322
 323     FirstModel = model;
 324     FirstModel->NextModel = 0L;
 325     FirstModel->SetRate(rate);
 326
 327   } else {                                     // subsequent model
 328
 329     while (model_iterator->NextModel != 0L) {
 330       model_iterator = model_iterator->NextModel;
 331     }
 332     model_iterator->NextModel = model;
 333     model_iterator->NextModel->SetRate(rate);
 334
 335   }
 336
 337   return 0;
 338 }
 339
 340 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 341
 342 bool FGFDMExec::Run(void)
 343 {
 344   bool success=true;
 345   FGModel* model_iterator;
 346
 347   model_iterator = FirstModel;
 348   if (model_iterator == 0L) return false;
 349
 350   Debug(2);
 351
 352   for (unsigned int i=1; i<ChildFDMList.size(); i++) {
 353     ChildFDMList[i]->AssignState(Propagate); // Transfer state to the child FDM
 354     ChildFDMList[i]->Run();
 355   }
 356
 357   // returns true if success
 358   // false if complete
 359   if (Script != 0 && !State->IntegrationSuspended()) success = Script->RunScript();
 360
 361   while (model_iterator != 0L) {
 362     model_iterator->Run();
 363     model_iterator = model_iterator->NextModel;
 364   }
 365
 366   Frame++;
 367   if (!Holding()) State->IncrTime();
 368   if (Terminate) success = false;
 369
 370   return (success);
 371 }
 372
 373 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 374 // This call will cause the sim time to reset to 0.0
 375
 376 bool FGFDMExec::RunIC(void)
 377 {
 378   State->SuspendIntegration();
 379   State->Initialize(IC);
 380   Run();
 381   State->ResumeIntegration();
 382
 383   return true;
 384 }
 385
 386 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 387 //
 388 // A private, internal function call for Tie-ing to a property, so it needs an
 389 // argument.
 390
 391 void FGFDMExec::ResetToInitialConditions(int mode)
 392 {
 393   if (mode == 1) {
 394     for (unsigned int i=0; i<Outputs.size(); i++) {
 395       Outputs[i]->SetStartNewFile(true);
 396     }
 397   }
 398
 399   ResetToInitialConditions();
 400 }
 401
 402 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 403
 404 void FGFDMExec::ResetToInitialConditions(void)
 405 {
 406   FGModel* model_iterator;
 407
 408   model_iterator = FirstModel;
 409   if (model_iterator == 0L || Constructing) return;
 410
 411   while (model_iterator != 0L) {
 412     model_iterator->InitModel();
 413     model_iterator = model_iterator->NextModel;
 414   }
 415
 416   RunIC();
 417   if (Script) Script->ResetEvents();
 418 }
 419
 420 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 421
 422 void FGFDMExec::SetGroundCallback(FGGroundCallback* p)
 423 {
 424   delete GroundCallback;
 425   GroundCallback = p;
 426 }
 427
 428 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 429
 430 double FGFDMExec::GetSimTime(void)
 431 {
 432   return (State->Getsim_time());
 433 }
 434
 435 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 436
 437 double FGFDMExec::GetDeltaT(void)
 438 {
 439   return (State->Getdt());
 440 }
 441
 442 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 443
 444 vector <string> FGFDMExec::EnumerateFDMs(void)
 445 {
 446   vector <string> FDMList;
 447
 448   FDMList.push_back(Aircraft->GetAircraftName());
 449
 450   for (unsigned int i=1; i<ChildFDMList.size(); i++) {
 451     FDMList.push_back(ChildFDMList[i]->exec->GetAircraft()->GetAircraftName());
 452   }
 453
 454   return FDMList;
 455 }
 456
 457 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 458
 459 bool FGFDMExec::LoadScript(string script)
 460 {
 461   bool result;
 462
 463   Script = new FGScript(this);
 464   result = Script->LoadScript(script);
 465
 466   return result;
 467 }
 468
 469 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 470
 471 bool FGFDMExec::LoadModel(string AircraftPath, string EnginePath, string SystemsPath,
 472                 string model, bool addModelToPath)
 473 {
 474   FGFDMExec::AircraftPath = AircraftPath;
 475   FGFDMExec::EnginePath = EnginePath;
 476   FGFDMExec::SystemsPath = SystemsPath;
 477
 478   return LoadModel(model, addModelToPath);
 479 }
 480
 481 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 482
 483 bool FGFDMExec::LoadModel(string model, bool addModelToPath)
 484 {
 485   string token;
 486   string aircraftCfgFileName;
 487   string separator = "/";
 488   Element* element = 0L;
 489   bool result = false; // initialize result to false, indicating input file not yet read
 490
 491   modelName = model; // Set the class modelName attribute
 492
 493   if( AircraftPath.empty() || EnginePath.empty() || SystemsPath.empty()) {
 494     cerr << "Error: attempted to load aircraft with undefined ";
 495     cerr << "aircraft, engine, and system paths" << endl;
 496     return false;
 497   }
 498
 499   FullAircraftPath = AircraftPath;
 500   if (addModelToPath) FullAircraftPath += separator + model;
 501   aircraftCfgFileName = FullAircraftPath + separator + model + ".xml";
 502
 503   if (modelLoaded) {
 504     DeAllocate();
 505     Allocate();
 506   }
 507
 508   int saved_debug_lvl = debug_lvl;
 509
 510   document = LoadXMLDocument(aircraftCfgFileName); // "document" is a class member
 511   if (document) {
 512     if (IsChild) debug_lvl = 0;
 513
 514     ReadPrologue(document);
 515
 516     if (IsChild) debug_lvl = saved_debug_lvl;
 517
 518     // Process the fileheader element in the aircraft config file. This element is OPTIONAL.
 519     element = document->FindElement("fileheader");
 520     if (element) {
 521       result = ReadFileHeader(element);
 522       if (!result) {
 523         cerr << endl << "Aircraft fileheader element has problems in file " << aircraftCfgFileName << endl;
 524         return result;
 525       }
 526     }
 527
 528     if (IsChild) debug_lvl = 0;
 529
 530     // Process the metrics element. This element is REQUIRED.
 531     element = document->FindElement("metrics");
 532     if (element) {
 533       result = Aircraft->Load(element);
 534       if (!result) {
 535         cerr << endl << "Aircraft metrics element has problems in file " << aircraftCfgFileName << endl;
 536         return result;
 537       }
 538     } else {
 539       cerr << endl << "No metrics element was found in the aircraft config file." << endl;
 540       return false;
 541     }
 542
 543     // Process the mass_balance element. This element is REQUIRED.
 544     element = document->FindElement("mass_balance");
 545     if (element) {
 546       result = MassBalance->Load(element);
 547       if (!result) {
 548         cerr << endl << "Aircraft mass_balance element has problems in file " << aircraftCfgFileName << endl;
 549         return result;
 550       }
 551     } else {
 552       cerr << endl << "No mass_balance element was found in the aircraft config file." << endl;
 553       return false;
 554     }
 555
 556     // Process the ground_reactions element. This element is REQUIRED.
 557     element = document->FindElement("ground_reactions");
 558     if (element) {
 559       result = GroundReactions->Load(element);
 560       if (!result) {
 561         cerr << endl << "Aircraft ground_reactions element has problems in file " << aircraftCfgFileName << endl;
 562         return result;
 563       }
 564     } else {
 565       cerr << endl << "No ground_reactions element was found in the aircraft config file." << endl;
 566       return false;
 567     }
 568
 569     // Process the external_reactions element. This element is OPTIONAL.
 570     element = document->FindElement("external_reactions");
 571     if (element) {
 572       result = ExternalReactions->Load(element);
 573       if (!result) {
 574         cerr << endl << "Aircraft external_reactions element has problems in file " << aircraftCfgFileName << endl;
 575         return result;
 576       }
 577     }
 578
 579     // Process the buoyant_forces element. This element is OPTIONAL.
 580     element = document->FindElement("buoyant_forces");
 581     if (element) {
 582       result = BuoyantForces->Load(element);
 583       if (!result) {
 584         cerr << endl << "Aircraft buoyant_forces element has problems in file " << aircraftCfgFileName << endl;
 585         return result;
 586       }
 587     }
 588
 589     // Process the propulsion element. This element is OPTIONAL.
 590     element = document->FindElement("propulsion");
 591     if (element) {
 592       result = Propulsion->Load(element);
 593       if (!result) {
 594         cerr << endl << "Aircraft propulsion element has problems in file " << aircraftCfgFileName << endl;
 595         return result;
 596       }
 597     }
 598
 599     // Process the system element[s]. This element is OPTIONAL, and there may be more than one.
 600     element = document->FindElement("system");
 601     while (element) {
 602       result = FCS->Load(element, FGFCS::stSystem);
 603       if (!result) {
 604         cerr << endl << "Aircraft system element has problems in file " << aircraftCfgFileName << endl;
 605         return result;
 606       }
 607       element = document->FindNextElement("system");
 608     }
 609
 610     // Process the autopilot element. This element is OPTIONAL.
 611     element = document->FindElement("autopilot");
 612     if (element) {
 613       result = FCS->Load(element, FGFCS::stAutoPilot);
 614       if (!result) {
 615         cerr << endl << "Aircraft autopilot element has problems in file " << aircraftCfgFileName << endl;
 616         return result;
 617       }
 618     }
 619
 620     // Process the flight_control element. This element is OPTIONAL.
 621     element = document->FindElement("flight_control");
 622     if (element) {
 623       result = FCS->Load(element, FGFCS::stFCS);
 624       if (!result) {
 625         cerr << endl << "Aircraft flight_control element has problems in file " << aircraftCfgFileName << endl;
 626         return result;
 627       }
 628     }
 629
 630     // Process the aerodynamics element. This element is OPTIONAL, but almost always expected.
 631     element = document->FindElement("aerodynamics");
 632     if (element) {
 633       result = Aerodynamics->Load(element);
 634       if (!result) {
 635         cerr << endl << "Aircraft aerodynamics element has problems in file " << aircraftCfgFileName << endl;
 636         return result;
 637       }
 638     } else {
 639       cerr << endl << "No expected aerodynamics element was found in the aircraft config file." << endl;
 640     }
 641
 642     // Process the input element. This element is OPTIONAL.
 643     element = document->FindElement("input");
 644     if (element) {
 645       result = Input->Load(element);
 646       if (!result) {
 647         cerr << endl << "Aircraft input element has problems in file " << aircraftCfgFileName << endl;
 648         return result;
 649       }
 650     }
 651
 652     // Process the output element[s]. This element is OPTIONAL, and there may be more than one.
 653     unsigned int idx=0;
 654     typedef int (FGOutput::*iOPMF)(void) const;
 655     element = document->FindElement("output");
 656     while (element) {
 657       if (debug_lvl > 0) cout << endl << "  Output data set: " << idx << "  ";
 658       FGOutput* Output = new FGOutput(this);
 659       Output->InitModel();
 660       Schedule(Output, 1);
 661       result = Output->Load(element);
 662       if (!result) {
 663         cerr << endl << "Aircraft output element has problems in file " << aircraftCfgFileName << endl;
 664         return result;
 665       } else {
 666         Outputs.push_back(Output);
 667         string outputProp = CreateIndexedPropertyName("simulation/output",idx);
 668         instance->Tie(outputProp+"/log_rate_hz", Output, (iOPMF)0, &FGOutput::SetRate);
 669         idx++;
 670       }
 671       element = document->FindNextElement("output");
 672     }
 673
 674     // Lastly, process the child element. This element is OPTIONAL - and NOT YET SUPPORTED.
 675     element = document->FindElement("child");
 676     if (element) {
 677       result = ReadChild(element);
 678       if (!result) {
 679         cerr << endl << "Aircraft child element has problems in file " << aircraftCfgFileName << endl;
 680         return result;
 681       }
 682     }
 683
 684     modelLoaded = true;
 685
 686     if (debug_lvl > 0) {
 687       cout << endl << fgblue << highint
 688            << "End of vehicle configuration loading." << endl
 689            << "-------------------------------------------------------------------------------"
 690            << reset << endl;
 691     }
 692
 693     if (IsChild) debug_lvl = saved_debug_lvl;
 694
 695   } else {
 696     cerr << fgred
 697          << "  JSBSim failed to open the configuration file: " << aircraftCfgFileName
 698          << fgdef << endl;
 699   }
 700
 701   struct PropertyCatalogStructure masterPCS;
 702   masterPCS.base_string = "";
 703   masterPCS.node = (FGPropertyManager*)Root;
 704
 705   BuildPropertyCatalog(&masterPCS);
 706
 707   return result;
 708 }
 709
 710 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 711
 712 void FGFDMExec::BuildPropertyCatalog(struct PropertyCatalogStructure* pcs)
 713 {
 714   struct PropertyCatalogStructure* pcsNew = new struct PropertyCatalogStructure;
 715   int node_idx = 0;
 716   char int_buf[10];
 717
 718   for (unsigned int i=0; i<pcs->node->nChildren(); i++) {
 719     pcsNew->base_string = pcs->base_string + "/" + pcs->node->getChild(i)->getName();
 720     node_idx = pcs->node->getChild(i)->getIndex();
 721     sprintf(int_buf, "[%d]", node_idx);
 722     if (node_idx != 0) pcsNew->base_string += string(int_buf);
 723     if (pcs->node->getChild(i)->nChildren() == 0) {
 724       if (pcsNew->base_string.substr(0,11) == string("/fdm/jsbsim")) {
 725         pcsNew->base_string = pcsNew->base_string.erase(0,12);
 726       }
 727       PropertyCatalog.push_back(pcsNew->base_string);
 728     } else {
 729       pcsNew->node = (FGPropertyManager*)pcs->node->getChild(i);
 730       BuildPropertyCatalog(pcsNew);
 731     }
 732   }
 733   delete pcsNew;
 734 }
 735
 736 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 737
 738 string FGFDMExec::QueryPropertyCatalog(string in)
 739 {
 740   string results="";
 741   for (unsigned i=0; i<PropertyCatalog.size(); i++) {
 742     if (PropertyCatalog[i].find(in) != string::npos) results += PropertyCatalog[i] + "\n";
 743   }
 744   if (results.empty()) return "No matches found\n";
 745   return results;
 746 }
 747
 748 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 749
 750 void FGFDMExec::PrintPropertyCatalog(void)
 751 {
 752   cout << endl;
 753   cout << "  " << fgblue << highint << underon << "Property Catalog for "
 754        << modelName << reset << endl << endl;
 755   for (unsigned i=0; i<PropertyCatalog.size(); i++) {
 756     cout << "    " << PropertyCatalog[i] << endl;
 757   }
 758 }
 759
 760 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 761
 762 bool FGFDMExec::ReadFileHeader(Element* el)
 763 {
 764   bool result = true; // true for success
 765
 766   if (debug_lvl == 0) return result;
 767
 768   if (IsChild) {
 769     cout << endl <<highint << fgblue << "Reading child model: " << IdFDM << reset << endl << endl;
 770   }
 771
 772   if (el->FindElement("description"))
 773     cout << "  Description:   " << el->FindElement("description")->GetDataLine() << endl;
 774   if (el->FindElement("author"))
 775     cout << "  Model Author:  " << el->FindElement("author")->GetDataLine() << endl;
 776   if (el->FindElement("filecreationdate"))
 777     cout << "  Creation Date: " << el->FindElement("filecreationdate")->GetDataLine() << endl;
 778   if (el->FindElement("version"))
 779     cout << "  Version:       " << el->FindElement("version")->GetDataLine() << endl;
 780
 781   return result;
 782 }
 783
 784 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 785
 786 bool FGFDMExec::ReadPrologue(Element* el) // el for ReadPrologue is the document element
 787 {
 788   bool result = true; // true for success
 789
 790   if (!el) return false;
 791
 792   string AircraftName = el->GetAttributeValue("name");
 793   Aircraft->SetAircraftName(AircraftName);
 794
 795   if (debug_lvl & 1) cout << underon << "Reading Aircraft Configuration File"
 796             << underoff << ": " << highint << AircraftName << normint << endl;
 797
 798   CFGVersion = el->GetAttributeValue("version");
 799   Release    = el->GetAttributeValue("release");
 800
 801   if (debug_lvl & 1)
 802     cout << "                            Version: " << highint << CFGVersion
 803                                                     << normint << endl;
 804   if (CFGVersion != needed_cfg_version) {
 805     cerr << endl << fgred << "YOU HAVE AN INCOMPATIBLE CFG FILE FOR THIS AIRCRAFT."
 806             " RESULTS WILL BE UNPREDICTABLE !!" << endl;
 807     cerr << "Current version needed is: " << needed_cfg_version << endl;
 808     cerr << "         You have version: " << CFGVersion << endl << fgdef << endl;
 809     return false;
 810   }
 811
 812   if (Release == "ALPHA" && (debug_lvl & 1)) {
 813     cout << endl << endl
 814          << highint << "This aircraft model is an " << fgred << Release
 815          << reset << highint << " release!!!" << endl << endl << reset
 816          << "This aircraft model may not even properly load, and probably"
 817          << " will not fly as expected." << endl << endl
 818          << fgred << highint << "Use this model for development purposes ONLY!!!"
 819          << normint << reset << endl << endl;
 820   } else if (Release == "BETA" && (debug_lvl & 1)) {
 821     cout << endl << endl
 822          << highint << "This aircraft model is a " << fgred << Release
 823          << reset << highint << " release!!!" << endl << endl << reset
 824          << "This aircraft model probably will not fly as expected." << endl << endl
 825          << fgblue << highint << "Use this model for development purposes ONLY!!!"
 826          << normint << reset << endl << endl;
 827   } else if (Release == "PRODUCTION" && (debug_lvl & 1)) {
 828     cout << endl << endl
 829          << highint << "This aircraft model is a " << fgblue << Release
 830          << reset << highint << " release." << endl << endl << reset;
 831   } else if (debug_lvl & 1) {
 832     cout << endl << endl
 833          << highint << "This aircraft model is an " << fgred << Release
 834          << reset << highint << " release!!!" << endl << endl << reset
 835          << "This aircraft model may not even properly load, and probably"
 836          << " will not fly as expected." << endl << endl
 837          << fgred << highint << "Use this model for development purposes ONLY!!!"
 838          << normint << reset << endl << endl;
 839   }
 840
 841   return result;
 842 }
 843
 844 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 845
 846 bool FGFDMExec::ReadChild(Element* el)
 847 {
 848   // Add a new childData object to the child FDM list
 849   // Populate that childData element with a new FDMExec object
 850   // Set the IsChild flag for that FDMExec object
 851   // Get the aircraft name
 852   // set debug level to print out no additional data for child objects
 853   // Load the model given the aircraft name
 854   // reset debug level to prior setting
 855
 856   string token;
 857
 858   struct childData* child = new childData;
 859
 860   child->exec = new FGFDMExec();
 861   child->exec->SetChild(true);
 862
 863   string childAircraft = el->GetAttributeValue("name");
 864   string sMated = el->GetAttributeValue("mated");
 865   if (sMated == "false") child->mated = false; // child objects are mated by default.
 866   string sInternal = el->GetAttributeValue("internal");
 867   if (sInternal == "true") child->internal = true; // child objects are external by default.
 868
 869   child->exec->SetAircraftPath( AircraftPath );
 870   child->exec->SetEnginePath( EnginePath );
 871   child->exec->SetSystemsPath( SystemsPath );
 872   child->exec->LoadModel(childAircraft);
 873
 874   Element* location = el->FindElement("location");
 875   if (location) {
 876     child->Loc = location->FindElementTripletConvertTo("IN");
 877   } else {
 878     cerr << endl << highint << fgred << "  No location was found for this child object!" << reset << endl;
 879     exit(-1);
 880   }
 881
 882   Element* orientation = el->FindElement("orient");
 883   if (orientation) {
 884     child->Orient = orientation->FindElementTripletConvertTo("RAD");
 885   } else if (debug_lvl > 0) {
 886     cerr << endl << highint << "  No orientation was found for this child object! Assuming 0,0,0." << reset << endl;
 887   }
 888
 889   ChildFDMList.push_back(child);
 890
 891   return true;
 892 }
 893
 894 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 895
 896 FGPropertyManager* FGFDMExec::GetPropertyManager(void)
 897 {
 898   return instance;
 899 }
 900
 901 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 902
 903 FGTrim* FGFDMExec::GetTrim(void)
 904 {
 905   delete Trim;
 906   Trim = new FGTrim(this,tNone);
 907   return Trim;
 908 }
 909
 910 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 911
 912 void FGFDMExec::DisableOutput(void)
 913 {
 914   for (unsigned i=0; i<Outputs.size(); i++) {
 915     Outputs[i]->Disable();
 916   }
 917 }
 918
 919 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 920
 921 void FGFDMExec::EnableOutput(void)
 922 {
 923   for (unsigned i=0; i<Outputs.size(); i++) {
 924     Outputs[i]->Enable();
 925   }
 926 }
 927
 928 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 929
 930 bool FGFDMExec::SetOutputDirectives(string fname)
 931 {
 932   bool result;
 933
 934   FGOutput* Output = new FGOutput(this);
 935   Output->SetDirectivesFile(fname);
 936   Output->InitModel();
 937   Schedule(Output,       1);
 938   result = Output->Load(0);
 939   Outputs.push_back(Output);
 940
 941   typedef int (FGOutput::*iOPMF)(void) const;
 942   string outputProp = CreateIndexedPropertyName("simulation/output",Outputs.size()-1);
 943   instance->Tie(outputProp+"/log_rate_hz", Output, (iOPMF)0, &FGOutput::SetRate);
 944
 945   return result;
 946 }
 947
 948 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 949
 950 void FGFDMExec::DoTrim(int mode)
 951 {
 952   double saved_time;
 953
 954   if (Constructing) return;
 955
 956   if (mode < 0 || mode > JSBSim::tNone) {
 957     cerr << endl << "Illegal trimming mode!" << endl << endl;
 958     return;
 959   }
 960   saved_time = State->Getsim_time();
 961   FGTrim trim(this, (JSBSim::TrimMode)mode);
 962   if ( !trim.DoTrim() ) cerr << endl << "Trim Failed" << endl << endl;
 963   trim.Report();
 964   State->Setsim_time(saved_time);
 965 }
 966
 967 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 968 /*
 969 void FGFDMExec::DoTrimAnalysis(int mode)
 970 {
 971   double saved_time;
 972   if (Constructing) return;
 973
 974   if (mode < 0 || mode > JSBSim::taNone) {
 975     cerr << endl << "Illegal trimming mode!" << endl << endl;
 976     return;
 977   }
 978   saved_time = State->Getsim_time();
 979
 980   FGTrimAnalysis trimAnalysis(this, (JSBSim::TrimAnalysisMode)mode);
 981
 982   if ( !trimAnalysis.Load(IC->GetInitFile(), false) ) {
 983     cerr << "A problem occurred with trim configuration file " << trimAnalysis.Load(IC->GetInitFile()) << endl;
 984     exit(-1);
 985   }
 986
 987   bool result = trimAnalysis.DoTrim();
 988
 989   if ( !result ) cerr << endl << "Trim Failed" << endl << endl;
 990
 991   trimAnalysis.Report();
 992   State->Setsim_time(saved_time);
 993
 994   EnableOutput();
 995   cout << "\nOutput: " << GetOutputFileName() << endl;
 996
 997 }
 998 */
 999 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1000
1001 void FGFDMExec::UseAtmosphereMSIS(void)
1002 {
1003   FGAtmosphere *oldAtmosphere = Atmosphere;
1004   Atmosphere = new MSIS(this);
1005   if (!Atmosphere->InitModel()) {
1006     cerr << fgred << "MSIS Atmosphere model init failed" << fgdef << endl;
1007     Error+=1;
1008   }
1009   delete oldAtmosphere;
1010 }
1011
1012 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1013
1014 void FGFDMExec::UseAtmosphereMars(void)
1015 {
1016 /*
1017   FGAtmosphere *oldAtmosphere = Atmosphere;
1018   Atmosphere = new FGMars(this);
1019   if (!Atmosphere->InitModel()) {
1020     cerr << fgred << "Mars Atmosphere model init failed" << fgdef << endl;
1021     Error+=1;
1022   }
1023   delete oldAtmosphere;
1024 */
1025 }
1026
1027 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1028 //    The bitmasked value choices are as follows:
1029 //    unset: In this case (the default) JSBSim would only print
1030 //       out the normally expected messages, essentially echoing
1031 //       the config files as they are read. If the environment
1032 //       variable is not set, debug_lvl is set to 1 internally
1033 //    0: This requests JSBSim not to output any messages
1034 //       whatsoever.
1035 //    1: This value explicity requests the normal JSBSim
1036 //       startup messages
1037 //    2: This value asks for a message to be printed out when
1038 //       a class is instantiated
1039 //    4: When this value is set, a message is displayed when a
1040 //       FGModel object executes its Run() method
1041 //    8: When this value is set, various runtime state variables
1042 //       are printed out periodically
1043 //    16: When set various parameters are sanity checked and
1044 //       a message is printed out when they go out of bounds
1045
1046 void FGFDMExec::Debug(int from)
1047 {
1048   if (debug_lvl <= 0) return;
1049
1050   if (debug_lvl & 1 && IdFDM == 0) { // Standard console startup message output
1051     if (from == 0) { // Constructor
1052       cout << "\n\n     " << highint << underon << "JSBSim Flight Dynamics Model v"
1053                                      << JSBSim_version << underoff << normint << endl;
1054       cout << halfint << "            [JSBSim-ML v" << needed_cfg_version << "]\n\n";
1055       cout << normint << "JSBSim startup beginning ...\n\n";
1056     } else if (from == 3) {
1057       cout << "\n\nJSBSim startup complete\n\n";
1058     }
1059   }
1060   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
1061     if (from == 0) cout << "Instantiated: FGFDMExec" << endl;
1062     if (from == 1) cout << "Destroyed:    FGFDMExec" << endl;
1063   }
1064   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
1065     if (from == 2) {
1066       cout << "================== Frame: " << Frame << "  Time: "
1067            << State->Getsim_time() << " dt: " << State->Getdt() << endl;
1068     }
1069   }
1070   if (debug_lvl & 8 ) { // Runtime state variables
1071   }
1072   if (debug_lvl & 16) { // Sanity checking
1073   }
1074   if (debug_lvl & 64) {
1075     if (from == 0) { // Constructor
1076       cout << IdSrc << endl;
1077       cout << IdHdr << endl;
1078     }
1079   }
1080 }
1081 }
1082
1083