1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 Purpose: Schedules and runs the model routines.
8 ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
10 This program is free software; you can redistribute it and/or modify it under
11 the terms of the GNU General Public License as published by the Free Software
12 Foundation; either version 2 of the License, or (at your option) any later
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 General Public License for more
20 You should have received a copy of the GNU 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.
24 Further information about the GNU General Public License can also be found on
25 the world wide web at http://www.gnu.org.
27 FUNCTIONAL DESCRIPTION
28 --------------------------------------------------------------------------------
30 This class wraps up the simulation scheduling routines.
33 --------------------------------------------------------------------------------
36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
37 COMMENTS, REFERENCES, and NOTES
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
40 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
45 # include <simgear/compiler.h>
46 # include STL_IOSTREAM
47 # include STL_ITERATOR
49 # if defined(sgi) && !defined(__GNUC__)
50 # include <iostream.h>
57 #include "FGFDMExec.h"
59 #include "FGAtmosphere.h"
61 #include "FGPropulsion.h"
62 #include "FGMassBalance.h"
63 #include "FGGroundReactions.h"
64 #include "FGAerodynamics.h"
65 #include "FGInertial.h"
66 #include "FGAircraft.h"
67 #include "FGTranslation.h"
68 #include "FGRotation.h"
69 #include "FGPosition.h"
70 #include "FGAuxiliary.h"
72 #include "FGConfigFile.h"
73 #include "FGInitialCondition.h"
74 #include "FGPropertyManager.h"
76 static const char *IdSrc = "$Id$";
77 static const char *IdHdr = ID_FDMEXEC;
79 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
83 unsigned int FGFDMExec::FDMctr = 0;
84 FGPropertyManager* FGFDMExec::master=0;
86 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
90 void checkTied( FGPropertyManager *node ) {
91 int N = node->nChildren();
93 for(int i=0;i<N;i++) {
94 if(node->getChild(i)->nChildren() ) {
95 checkTied( (FGPropertyManager*)node->getChild(i) );
96 } else if( node->getChild(i)->isTied() ) {
97 name=((FGPropertyManager*)node->getChild(i))->GetFullyQualifiedName();
98 cerr << name << " is tied" << endl;
105 FGFDMExec::FGFDMExec(FGPropertyManager* root)
137 char* num = getenv("JSBSIM_DEBUG");
138 if (!num) debug_lvl = 1;
139 else debug_lvl = atoi(num); // set debug level
140 } catch (...) { // if error set to 1
144 if (root == 0) master= new FGPropertyManager;
147 instance = master->GetNode("/fdm/jsbsim",IdFDM,true);
152 // this is here to catch errors in binding member functions
153 // to the property tree.
156 } catch ( string msg ) {
157 cout << "Caught error: " << msg << endl;
162 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
164 FGFDMExec::~FGFDMExec()
168 checkTied( instance );
169 } catch ( string msg ) {
170 cout << "Caught error: " << msg << endl;
173 for (unsigned int i=1; i<SlaveFDMList.size(); i++) delete SlaveFDMList[i]->exec;
174 SlaveFDMList.clear();
179 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
181 bool FGFDMExec::Allocate(void)
185 Atmosphere = new FGAtmosphere(this);
186 FCS = new FGFCS(this);
187 Propulsion = new FGPropulsion(this);
188 MassBalance = new FGMassBalance(this);
189 Aerodynamics = new FGAerodynamics (this);
190 Inertial = new FGInertial(this);
191 GroundReactions = new FGGroundReactions(this);
192 Aircraft = new FGAircraft(this);
193 Translation = new FGTranslation(this);
194 Rotation = new FGRotation(this);
195 Position = new FGPosition(this);
196 Auxiliary = new FGAuxiliary(this);
197 Output = new FGOutput(this);
199 State = new FGState(this); // This must be done here, as the FGState
200 // class needs valid pointers to the above
203 // Initialize models so they can communicate with each other
205 if (!Atmosphere->InitModel()) {
206 cerr << fgred << "Atmosphere model init failed" << fgdef << endl;
208 if (!FCS->InitModel()) {
209 cerr << fgred << "FCS model init failed" << fgdef << endl;
211 if (!Propulsion->InitModel()) {
212 cerr << fgred << "FGPropulsion model init failed" << fgdef << endl;
214 if (!MassBalance->InitModel()) {
215 cerr << fgred << "FGMassBalance model init failed" << fgdef << endl;
217 if (!Aerodynamics->InitModel()) {
218 cerr << fgred << "FGAerodynamics model init failed" << fgdef << endl;
220 if (!Inertial->InitModel()) {
221 cerr << fgred << "FGInertial model init failed" << fgdef << endl;
223 if (!GroundReactions->InitModel()) {
224 cerr << fgred << "Ground Reactions model init failed" << fgdef << endl;
226 if (!Aircraft->InitModel()) {
227 cerr << fgred << "Aircraft model init failed" << fgdef << endl;
229 if (!Translation->InitModel()) {
230 cerr << fgred << "Translation model init failed" << fgdef << endl;
232 if (!Rotation->InitModel()) {
233 cerr << fgred << "Rotation model init failed" << fgdef << endl;
235 if (!Position->InitModel()) {
236 cerr << fgred << "Position model init failed" << fgdef << endl;
238 if (!Auxiliary->InitModel()) {
239 cerr << fgred << "Auxiliary model init failed" << fgdef << endl;
241 if (!Output->InitModel()) {
242 cerr << fgred << "Output model init failed" << fgdef << endl;
245 if (Error > 0) result = false;
247 IC = new FGInitialCondition(this);
248 //Trim is allocated as needed by GetTrim()
251 // Schedule a model. The second arg (the integer) is the pass number. For
252 // instance, the atmosphere model gets executed every fifth pass it is called
253 // by the executive. Everything else here gets executed each pass.
255 Schedule(Atmosphere, 1);
257 Schedule(Propulsion, 1);
258 Schedule(MassBalance, 1);
259 Schedule(Aerodynamics, 1);
260 Schedule(Inertial, 1);
261 Schedule(GroundReactions, 1);
262 Schedule(Aircraft, 1);
263 Schedule(Rotation, 1);
264 Schedule(Translation, 1);
265 Schedule(Position, 1);
266 Schedule(Auxiliary, 1);
268 //IC and Trim are *not* scheduled objects
277 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
279 bool FGFDMExec::DeAllocate(void) {
287 delete GroundReactions;
323 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
325 int FGFDMExec::Schedule(FGModel* model, int rate)
327 FGModel* model_iterator;
329 model_iterator = FirstModel;
331 if (model_iterator == 0L) { // this is the first model
334 FirstModel->NextModel = 0L;
335 FirstModel->SetRate(rate);
337 } else { // subsequent model
339 while (model_iterator->NextModel != 0L) {
340 model_iterator = model_iterator->NextModel;
342 model_iterator->NextModel = model;
343 model_iterator->NextModel->SetRate(rate);
350 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
352 bool FGFDMExec::Run(void)
354 FGModel* model_iterator;
356 if (frozen) return true;
358 model_iterator = FirstModel;
359 if (model_iterator == 0L) return false;
363 for (unsigned int i=1; i<SlaveFDMList.size(); i++) {
364 // SlaveFDMList[i]->exec->State->Initialize(); // Transfer state to the slave FDM
365 // SlaveFDMList[i]->exec->Run();
368 while (model_iterator != 0L) {
369 model_iterator->Run();
370 model_iterator = model_iterator->NextModel;
378 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
380 bool FGFDMExec::RunIC(void)
383 State->Initialize(IC);
389 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
391 vector <string> FGFDMExec::EnumerateFDMs(void)
393 vector <string> FDMList;
395 FDMList.push_back(Aircraft->GetAircraftName());
397 for (unsigned int i=1; i<SlaveFDMList.size(); i++) {
398 FDMList.push_back(SlaveFDMList[i]->exec->GetAircraft()->GetAircraftName());
404 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
406 bool FGFDMExec::LoadModel(string AircraftPath, string EnginePath, string model) {
407 FGFDMExec::AircraftPath=AircraftPath;
408 FGFDMExec::EnginePath=EnginePath;
409 return LoadModel(model);
412 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
414 bool FGFDMExec::LoadModel(string model)
418 string aircraftCfgFileName;
420 if( AircraftPath.empty() || EnginePath.empty() ) {
421 cerr << "Error: attempted to load aircraft with undefined ";
422 cerr << "aircraft and engine paths" << endl;
427 aircraftCfgFileName = AircraftPath + "/" + model + "/" + model + ".xml";
429 aircraftCfgFileName = AircraftPath + ";" + model + ";" + model + ".xml";
432 FGConfigFile AC_cfg(aircraftCfgFileName);
433 if (!AC_cfg.IsOpen()) return false;
442 if (!ReadPrologue(&AC_cfg)) return false;
444 while ((AC_cfg.GetNextConfigLine() != string("EOF")) &&
445 (token = AC_cfg.GetValue()) != string("/FDM_CONFIG")) {
446 if (token == "METRICS") {
447 if (debug_lvl > 0) cout << fgcyan << "\n Reading Metrics" << fgdef << endl;
448 if (!ReadMetrics(&AC_cfg)) result = false;
449 } else if (token == "SLAVE") {
450 if (debug_lvl > 0) cout << fgcyan << "\n Reading Slave flight vehicle: " << fgdef
451 << AC_cfg.GetValue("NAME") << endl;
452 if (!ReadSlave(&AC_cfg)) result = false;
453 } else if (token == "AERODYNAMICS") {
454 if (debug_lvl > 0) cout << fgcyan << "\n Reading Aerodynamics" << fgdef << endl;
455 if (!ReadAerodynamics(&AC_cfg)) result = false;
456 } else if (token == "UNDERCARRIAGE") {
457 if (debug_lvl > 0) cout << fgcyan << "\n Reading Landing Gear" << fgdef << endl;
458 if (!ReadUndercarriage(&AC_cfg)) result = false;
459 } else if (token == "PROPULSION") {
460 if (debug_lvl > 0) cout << fgcyan << "\n Reading Propulsion" << fgdef << endl;
461 if (!ReadPropulsion(&AC_cfg)) result = false;
462 } else if (token == "FLIGHT_CONTROL") {
463 if (debug_lvl > 0) cout << fgcyan << "\n Reading Flight Control" << fgdef << endl;
464 if (!ReadFlightControls(&AC_cfg)) result = false;
465 } else if (token == "AUTOPILOT") {
466 if (debug_lvl > 0) cout << fgcyan << "\n Reading Autopilot" << fgdef << endl;
467 if (!ReadFlightControls(&AC_cfg)) result = false;
468 } else if (token == "OUTPUT") {
469 if (debug_lvl > 0) cout << fgcyan << "\n Reading Output directives" << fgdef << endl;
470 if (!ReadOutput(&AC_cfg)) result = false;
479 << " FGFDMExec: Failed to load aircraft and/or engine model"
486 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
488 bool FGFDMExec::ReadPrologue(FGConfigFile* AC_cfg)
490 string token = AC_cfg->GetValue();
494 AircraftName = AC_cfg->GetValue("NAME");
495 Aircraft->SetAircraftName(AircraftName);
497 if (debug_lvl > 0) cout << underon << "Reading Aircraft Configuration File"
498 << underoff << ": " << highint << AircraftName << normint << endl;
499 scratch = AC_cfg->GetValue("VERSION").c_str();
501 CFGVersion = AC_cfg->GetValue("VERSION");
504 cout << " Version: " << highint << CFGVersion
506 if (CFGVersion != needed_cfg_version) {
507 cerr << endl << fgred << "YOU HAVE AN INCOMPATIBLE CFG FILE FOR THIS AIRCRAFT."
508 " RESULTS WILL BE UNPREDICTABLE !!" << endl;
509 cerr << "Current version needed is: " << needed_cfg_version << endl;
510 cerr << " You have version: " << CFGVersion << endl << fgdef << endl;
517 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
519 bool FGFDMExec::ReadSlave(FGConfigFile* AC_cfg)
521 // Add a new slaveData object to the slave FDM list
522 // Populate that slaveData element with a new FDMExec object
523 // Set the IsSlave flag for that FDMExec object
524 // Get the aircraft name
525 // set debug level to print out no additional data for slave objects
526 // Load the model given the aircraft name
527 // reset debug level to prior setting
529 int saved_debug_lvl = debug_lvl;
532 SlaveFDMList.push_back(new slaveData);
533 SlaveFDMList.back()->exec = new FGFDMExec();
534 SlaveFDMList.back()->exec->SetSlave();
536 string AircraftName = AC_cfg->GetValue("FILE");
538 debug_lvl = 0; // turn off debug output for slave vehicle
540 SlaveFDMList.back()->exec->SetAircraftPath( AircraftPath );
541 SlaveFDMList.back()->exec->SetEnginePath( EnginePath );
542 SlaveFDMList.back()->exec->LoadModel(AircraftName);
543 debug_lvl = saved_debug_lvl; // turn debug output back on for master vehicle
545 AC_cfg->GetNextConfigLine();
546 while ((token = AC_cfg->GetValue()) != string("/SLAVE")) {
548 if (token == "XLOC") { *AC_cfg >> SlaveFDMList.back()->x; }
549 else if (token == "YLOC") { *AC_cfg >> SlaveFDMList.back()->y; }
550 else if (token == "ZLOC") { *AC_cfg >> SlaveFDMList.back()->z; }
551 else if (token == "PITCH") { *AC_cfg >> SlaveFDMList.back()->pitch;}
552 else if (token == "YAW") { *AC_cfg >> SlaveFDMList.back()->yaw; }
553 else if (token == "ROLL") { *AC_cfg >> SlaveFDMList.back()->roll; }
554 else cerr << "Unknown identifier: " << token << " in slave vehicle definition" << endl;
558 cout << " X = " << SlaveFDMList.back()->x << endl;
559 cout << " Y = " << SlaveFDMList.back()->y << endl;
560 cout << " Z = " << SlaveFDMList.back()->z << endl;
561 cout << " Pitch = " << SlaveFDMList.back()->pitch << endl;
562 cout << " Yaw = " << SlaveFDMList.back()->yaw << endl;
563 cout << " Roll = " << SlaveFDMList.back()->roll << endl;
569 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
571 bool FGFDMExec::ReadPropulsion(FGConfigFile* AC_cfg)
573 if (!Propulsion->Load(AC_cfg)) {
574 cerr << " Propulsion not successfully loaded" << endl;
580 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
582 bool FGFDMExec::ReadFlightControls(FGConfigFile* AC_cfg)
584 if (!FCS->Load(AC_cfg)) {
585 cerr << " Flight Controls not successfully loaded" << endl;
591 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
593 bool FGFDMExec::ReadAerodynamics(FGConfigFile* AC_cfg)
595 if (!Aerodynamics->Load(AC_cfg)) {
596 cerr << " Aerodynamics not successfully loaded" << endl;
602 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
604 bool FGFDMExec::ReadUndercarriage(FGConfigFile* AC_cfg)
606 if (!GroundReactions->Load(AC_cfg)) {
607 cerr << " Ground Reactions not successfully loaded" << endl;
613 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
615 bool FGFDMExec::ReadMetrics(FGConfigFile* AC_cfg)
617 if (!Aircraft->Load(AC_cfg)) {
618 cerr << " Aircraft metrics not successfully loaded" << endl;
624 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
626 bool FGFDMExec::ReadOutput(FGConfigFile* AC_cfg)
628 if (!Output->Load(AC_cfg)) {
629 cerr << " Output not successfully loaded" << endl;
635 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
637 FGPropertyManager* FGFDMExec::GetPropertyManager(void) {
641 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
643 FGTrim* FGFDMExec::GetTrim(void) {
645 Trim = new FGTrim(this,tNone);
649 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
650 // The bitmasked value choices are as follows:
651 // unset: In this case (the default) JSBSim would only print
652 // out the normally expected messages, essentially echoing
653 // the config files as they are read. If the environment
654 // variable is not set, debug_lvl is set to 1 internally
655 // 0: This requests JSBSim not to output any messages
657 // 1: This value explicity requests the normal JSBSim
659 // 2: This value asks for a message to be printed out when
660 // a class is instantiated
661 // 4: When this value is set, a message is displayed when a
662 // FGModel object executes its Run() method
663 // 8: When this value is set, various runtime state variables
664 // are printed out periodically
665 // 16: When set various parameters are sanity checked and
666 // a message is printed out when they go out of bounds
668 void FGFDMExec::Debug(int from)
670 if (debug_lvl <= 0) return;
672 if (debug_lvl & 1 && IdFDM == 0) { // Standard console startup message output
673 if (from == 0) { // Constructor
674 cout << "\n\n " << highint << underon << "JSBSim Flight Dynamics Model v"
675 << JSBSim_version << underoff << normint << endl;
676 cout << halfint << " [cfg file spec v" << needed_cfg_version << "]\n\n";
677 cout << normint << "JSBSim startup beginning ...\n\n";
678 } else if (from == 3) {
679 cout << "\n\nJSBSim startup complete\n\n";
682 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
683 if (from == 0) cout << "Instantiated: FGFDMExec" << endl;
684 if (from == 1) cout << "Destroyed: FGFDMExec" << endl;
686 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
688 cout << "================== Frame: " << Frame << " Time: "
689 << State->Getsim_time() << endl;
692 if (debug_lvl & 8 ) { // Runtime state variables
694 if (debug_lvl & 16) { // Sanity checking
696 if (debug_lvl & 64) {
697 if (from == 0) { // Constructor
698 cout << IdSrc << endl;
699 cout << IdHdr << endl;