]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGModel.cpp
Connect the FlightGear /environment/turbulence-norm property to the
[flightgear.git] / src / FDM / JSBSim / FGModel.cpp
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2
3  Module:       FGModel.cpp
4  Author:       Jon Berndt
5  Date started: 11/11/98
6  Purpose:      Base class for all models
7  Called by:    FGSimExec, et. al.
8
9  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
10
11  This program is free software; you can redistribute it and/or modify it under
12  the terms of the GNU General Public License as published by the Free Software
13  Foundation; either version 2 of the License, or (at your option) any later
14  version.
15
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 General Public License for more
19  details.
20
21  You should have received a copy of the GNU 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.
24
25  Further information about the GNU General Public License can also be found on
26  the world wide web at http://www.gnu.org.
27
28 FUNCTIONAL DESCRIPTION
29 --------------------------------------------------------------------------------
30 This base class for the FGAero, FGRotational, etc. classes defines methods
31 common to all models.
32
33 HISTORY
34 --------------------------------------------------------------------------------
35 11/11/98   JSB   Created
36
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 INCLUDES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40
41 #include "FGModel.h"
42 #include "FGState.h"
43 #include "FGFDMExec.h"
44 #include "FGAtmosphere.h"
45 #include "FGFCS.h"
46 #include "FGPropulsion.h"
47 #include "FGMassBalance.h"
48 #include "FGAerodynamics.h"
49 #include "FGInertial.h"
50 #include "FGGroundReactions.h"
51 #include "FGAircraft.h"
52 #include "FGTranslation.h"
53 #include "FGRotation.h"
54 #include "FGPosition.h"
55 #include "FGAuxiliary.h"
56 #include "FGOutput.h"
57
58 namespace JSBSim {
59
60 static const char *IdSrc = "$Id$";
61 static const char *IdHdr = ID_MODEL;
62
63 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
64 GLOBAL DECLARATIONS
65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
66
67 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
68 CLASS IMPLEMENTATION
69 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
70
71 FGModel::FGModel(FGFDMExec* fdmex)
72 {
73   FDMExec     = fdmex;
74   NextModel   = 0L;
75
76   State           = 0;
77   Atmosphere      = 0;
78   FCS             = 0;
79   Propulsion      = 0;
80   MassBalance     = 0;
81   Aerodynamics    = 0;
82   Inertial        = 0;
83   GroundReactions = 0;
84   Aircraft        = 0;
85   Translation     = 0;
86   Rotation        = 0;
87   Position        = 0;
88   Auxiliary       = 0;
89   Output          = 0;
90   
91   //in order for FGModel derived classes to self-bind (that is, call
92   //their bind function in the constructor, the PropertyManager pointer
93   //must be brought up now.
94   PropertyManager = FDMExec->GetPropertyManager();
95   
96   exe_ctr     = 1;
97
98   if (debug_lvl & 2) cout << "              FGModel Base Class" << endl;
99 }
100
101 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
102
103 FGModel::~FGModel()
104 {
105   if (debug_lvl & 2) cout << "Destroyed:    FGModel" << endl;
106 }
107
108 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
109
110 bool FGModel::InitModel(void)
111 {
112   State           = FDMExec->GetState();
113   Atmosphere      = FDMExec->GetAtmosphere();
114   FCS             = FDMExec->GetFCS();
115   Propulsion      = FDMExec->GetPropulsion();
116   MassBalance     = FDMExec->GetMassBalance();
117   Aerodynamics    = FDMExec->GetAerodynamics();
118   Inertial        = FDMExec->GetInertial();
119   GroundReactions = FDMExec->GetGroundReactions();
120   Aircraft        = FDMExec->GetAircraft();
121   Translation     = FDMExec->GetTranslation();
122   Rotation        = FDMExec->GetRotation();
123   Position        = FDMExec->GetPosition();
124   Auxiliary       = FDMExec->GetAuxiliary();
125   Output          = FDMExec->GetOutput();
126   
127   if (!State ||
128       !Atmosphere ||
129       !FCS ||
130       !Propulsion ||
131       !MassBalance ||
132       !Aerodynamics ||
133       !Inertial ||
134       !GroundReactions ||
135       !Aircraft ||
136       !Translation ||
137       !Rotation ||
138       !Position ||
139       !Auxiliary ||
140       !Output) return(false);
141   else return(true);
142 }
143
144 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
145
146 bool FGModel::Run()
147 {
148   if (debug_lvl & 4) cout << "Entering Run() for model " << Name << endl;
149
150   if (exe_ctr == 1) {
151     if (exe_ctr++ >= rate) exe_ctr = 1;
152     return false;
153   } else {
154     if (exe_ctr++ >= rate) exe_ctr = 1;
155     return true;
156   }
157 }
158
159 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
160 //    The bitmasked value choices are as follows:
161 //    unset: In this case (the default) JSBSim would only print
162 //       out the normally expected messages, essentially echoing
163 //       the config files as they are read. If the environment
164 //       variable is not set, debug_lvl is set to 1 internally
165 //    0: This requests JSBSim not to output any messages
166 //       whatsoever.
167 //    1: This value explicity requests the normal JSBSim
168 //       startup messages
169 //    2: This value asks for a message to be printed out when
170 //       a class is instantiated
171 //    4: When this value is set, a message is displayed when a
172 //       FGModel object executes its Run() method
173 //    8: When this value is set, various runtime state variables
174 //       are printed out periodically
175 //    16: When set various parameters are sanity checked and
176 //       a message is printed out when they go out of bounds
177
178 void FGModel::Debug(int from)
179 {
180   if (debug_lvl <= 0) return;
181
182   if (debug_lvl & 1) { // Standard console startup message output
183     if (from == 0) { // Constructor
184
185     }
186   }
187   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
188     if (from == 0) cout << "Instantiated: FGModel" << endl;
189     if (from == 1) cout << "Destroyed:    FGModel" << endl;
190   }
191   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
192   }
193   if (debug_lvl & 8 ) { // Runtime state variables
194   }
195   if (debug_lvl & 16) { // Sanity checking
196   }
197   if (debug_lvl & 64) {
198     if (from == 0) { // Constructor
199       cout << IdSrc << endl;
200       cout << IdHdr << endl;
201     }
202   }
203 }
204 }