1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 Purpose: Base class for all models
7 Called by: FGSimExec, et. al.
9 ------------- Copyright (C) 1999 Jon S. Berndt (jon@jsbsim.org) -------------
11 This program is free software; you can redistribute it and/or modify it under
12 the terms of the GNU Lesser General Public License as published by the Free Software
13 Foundation; either version 2 of the License, or (at your option) any later
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
21 You should have received a copy of the GNU Lesser General Public License along with
22 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
23 Place - Suite 330, Boston, MA 02111-1307, USA.
25 Further information about the GNU Lesser General Public License can also be found on
26 the world wide web at http://www.gnu.org.
28 FUNCTIONAL DESCRIPTION
29 --------------------------------------------------------------------------------
30 This base class for the FGAerodynamics, FGPropagate, etc. classes defines methods
34 --------------------------------------------------------------------------------
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
43 #include "FGFDMExec.h"
49 static const char *IdSrc = "$Id: FGModel.cpp,v 1.19 2011/05/22 12:44:30 jberndt Exp $";
50 static const char *IdHdr = ID_MODEL;
52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
60 FGModel::FGModel(FGFDMExec* fdmex)
64 //in order for FGModel derived classes to self-bind (that is, call
65 //their bind function in the constructor, the PropertyManager pointer
66 //must be brought up now.
67 PropertyManager = FDMExec->GetPropertyManager();
72 if (debug_lvl & 2) cout << " FGModel Base Class" << endl;
75 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
79 if (debug_lvl & 2) cout << "Destroyed: FGModel" << endl;
82 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
84 bool FGModel::InitModel(void)
89 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91 bool FGModel::Run(bool Holding)
93 if (debug_lvl & 4) cout << "Entering Run() for model " << Name << endl;
95 if (rate == 1) return false; // Fast exit if nothing to do
97 if (exe_ctr >= rate) exe_ctr = 0;
99 if (exe_ctr++ == 1) return false;
103 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
104 // The bitmasked value choices are as follows:
105 // unset: In this case (the default) JSBSim would only print
106 // out the normally expected messages, essentially echoing
107 // the config files as they are read. If the environment
108 // variable is not set, debug_lvl is set to 1 internally
109 // 0: This requests JSBSim not to output any messages
111 // 1: This value explicity requests the normal JSBSim
113 // 2: This value asks for a message to be printed out when
114 // a class is instantiated
115 // 4: When this value is set, a message is displayed when a
116 // FGModel object executes its Run() method
117 // 8: When this value is set, various runtime state variables
118 // are printed out periodically
119 // 16: When set various parameters are sanity checked and
120 // a message is printed out when they go out of bounds
122 void FGModel::Debug(int from)
124 if (debug_lvl <= 0) return;
126 if (debug_lvl & 1) { // Standard console startup message output
127 if (from == 0) { // Constructor
131 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
132 if (from == 0) cout << "Instantiated: FGModel" << endl;
133 if (from == 1) cout << "Destroyed: FGModel" << endl;
135 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
137 if (debug_lvl & 8 ) { // Runtime state variables
139 if (debug_lvl & 16) { // Sanity checking
141 if (debug_lvl & 64) {
142 if (from == 0) { // Constructor
143 cout << IdSrc << endl;
144 cout << IdHdr << endl;