]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGModel.cpp
Minor property name change to avoid some minor confusion.
[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 static const char *IdSrc = "$Id$";
59 static const char *IdHdr = ID_MODEL;
60
61 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
62 GLOBAL DECLARATIONS
63 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
64
65 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
66 CLASS IMPLEMENTATION
67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
68
69 FGModel::FGModel(FGFDMExec* fdmex)
70 {
71   FDMExec     = fdmex;
72   NextModel   = 0L;
73
74   State           = 0;
75   Atmosphere      = 0;
76   FCS             = 0;
77   Propulsion      = 0;
78   MassBalance     = 0;
79   Aerodynamics    = 0;
80   Inertial        = 0;
81   GroundReactions = 0;
82   Aircraft        = 0;
83   Translation     = 0;
84   Rotation        = 0;
85   Position        = 0;
86   Auxiliary       = 0;
87   Output          = 0;
88   
89   //in order for FGModel derived classes to self-bind (that is, call
90   //their bind function in the constructor, the PropertyManager pointer
91   //must be brought up now.
92   PropertyManager = FDMExec->GetPropertyManager();
93   
94   exe_ctr     = 1;
95
96   if (debug_lvl & 2) cout << "              FGModel Base Class" << endl;
97 }
98
99 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
100
101 FGModel::~FGModel()
102 {
103   if (debug_lvl & 2) cout << "Destroyed:    FGModel" << endl;
104 }
105
106 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
107
108 bool FGModel::InitModel(void)
109 {
110   State           = FDMExec->GetState();
111   Atmosphere      = FDMExec->GetAtmosphere();
112   FCS             = FDMExec->GetFCS();
113   Propulsion      = FDMExec->GetPropulsion();
114   MassBalance     = FDMExec->GetMassBalance();
115   Aerodynamics    = FDMExec->GetAerodynamics();
116   Inertial        = FDMExec->GetInertial();
117   GroundReactions = FDMExec->GetGroundReactions();
118   Aircraft        = FDMExec->GetAircraft();
119   Translation     = FDMExec->GetTranslation();
120   Rotation        = FDMExec->GetRotation();
121   Position        = FDMExec->GetPosition();
122   Auxiliary       = FDMExec->GetAuxiliary();
123   Output          = FDMExec->GetOutput();
124   
125   if (!State ||
126       !Atmosphere ||
127       !FCS ||
128       !Propulsion ||
129       !MassBalance ||
130       !Aerodynamics ||
131       !Inertial ||
132       !GroundReactions ||
133       !Aircraft ||
134       !Translation ||
135       !Rotation ||
136       !Position ||
137       !Auxiliary ||
138       !Output) return(false);
139   else return(true);
140 }
141
142 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
143
144 bool FGModel::Run()
145 {
146   if (debug_lvl & 4) cout << "Entering Run() for model " << Name << endl;
147
148   if (exe_ctr == 1) {
149     if (exe_ctr++ >= rate) exe_ctr = 1;
150     return false;
151   } else {
152     if (exe_ctr++ >= rate) exe_ctr = 1;
153     return true;
154   }
155 }
156
157 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
158 //    The bitmasked value choices are as follows:
159 //    unset: In this case (the default) JSBSim would only print
160 //       out the normally expected messages, essentially echoing
161 //       the config files as they are read. If the environment
162 //       variable is not set, debug_lvl is set to 1 internally
163 //    0: This requests JSBSim not to output any messages
164 //       whatsoever.
165 //    1: This value explicity requests the normal JSBSim
166 //       startup messages
167 //    2: This value asks for a message to be printed out when
168 //       a class is instantiated
169 //    4: When this value is set, a message is displayed when a
170 //       FGModel object executes its Run() method
171 //    8: When this value is set, various runtime state variables
172 //       are printed out periodically
173 //    16: When set various parameters are sanity checked and
174 //       a message is printed out when they go out of bounds
175
176 void FGModel::Debug(int from)
177 {
178   if (debug_lvl <= 0) return;
179
180   if (debug_lvl & 1) { // Standard console startup message output
181     if (from == 0) { // Constructor
182
183     }
184   }
185   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
186     if (from == 0) cout << "Instantiated: FGModel" << endl;
187     if (from == 1) cout << "Destroyed:    FGModel" << endl;
188   }
189   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
190   }
191   if (debug_lvl & 8 ) { // Runtime state variables
192   }
193   if (debug_lvl & 16) { // Sanity checking
194   }
195   if (debug_lvl & 64) {
196     if (from == 0) { // Constructor
197       cout << IdSrc << endl;
198       cout << IdHdr << endl;
199     }
200   }
201 }
202