1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
8 This program is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free Software
10 Foundation; either version 2 of the License, or (at your option) any later
13 This program is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 You should have received a copy of the GNU General Public License along with
19 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
20 Place - Suite 330, Boston, MA 02111-1307, USA.
22 Further information about the GNU General Public License can also be found on
23 the world wide web at http://www.gnu.org.
26 --------------------------------------------------------------------------------
28 7/31/99 TP Added RunIC function that runs the sim so that every frame
29 begins with the IC values from the given FGInitialCondition
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
36 #ifndef FGFDMEXEC_HEADER_H
37 #define FGFDMEXEC_HEADER_H
39 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
41 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
44 #include "FGInitialCondition.h"
45 #include "FGJSBBase.h"
46 #include "FGPropertyManager.h"
49 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
51 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
53 #define ID_FDMEXEC "$Id$"
55 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
59 class FGInitialCondition;
61 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
62 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
63 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
65 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
69 /** Encapsulates the JSBSim simulation executive.
73 @doc This class is the interface class through which all other simulation classes
74 are instantiated, initialized, and run. When integrated with FlightGear (or
75 other flight simulator) this class is typically instantiated by an interface
76 class on the simulator side.
78 When an aircraft model is loaded the config file is parsed and for each of the
79 sections of the config file (propulsion, flight control, etc.) the
80 corresponding "ReadXXX()" method is called. From within this method the
81 "Load()" method of that system is called (e.g. LoadFCS).
83 <h4>JSBSim Debugging Directives</h4>
85 This describes to any interested entity the debug level
86 requested by setting the JSBSIM_DEBUG environment variable.
87 The bitmasked value choices are as follows:<ol>
88 <li><b>unset</b>: In this case (the default) JSBSim would only print
89 out the normally expected messages, essentially echoing
90 the config files as they are read. If the environment
91 variable is not set, debug_lvl is set to 1 internally</li>
92 <li><b>0</b>: This requests JSBSim not to output any messages
94 <li><b>1</b>: This value explicity requests the normal JSBSim
96 <li><b>2</b>: This value asks for a message to be printed out when
97 a class is instantiated</li>
98 <li><b>4</b>: When this value is set, a message is displayed when a
99 FGModel object executes its Run() method</li>
100 <li><b>8</b>: When this value is set, various runtime state variables
101 are printed out periodically</li>
102 <li><b>16</b>: When set various parameters are sanity checked and
103 a message is printed out when they go out of bounds</li>
108 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
110 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
112 class FGFDMExec : public FGJSBBase
117 /// Default constructor
118 FGFDMExec(FGPropertyManager* root = 0);
120 /// Default destructor
123 /** This routine places a model into the runlist at the specified rate. The
124 "rate" is not really a clock rate. It represents how many calls to the
125 FGFDMExec::Run() method must be made before the model is executed. A
126 value of 1 means that the model will be executed for each call to the
127 exec's Run() method. A value of 5 means that the model will only be
128 executed every 5th call to the exec's Run() method.
129 @param model A pointer to the model being scheduled.
130 @param rate The rate at which to execute the model as described above.
131 @return Currently returns 0 always. */
132 int Schedule(FGModel* model, int rate);
134 /** This executes each scheduled model in succession.
135 @return true if successful, false if sim should be ended */
138 /** Initializes the sim with a set of initial conditions.
139 @param fgic A pointer to a filled out initial conditions class which
140 describes the desired initial conditions.
141 @return true if successful
143 bool RunIC(FGInitialCondition *fgic);
146 void Freeze(void) {frozen = true;}
149 void Resume(void) {frozen = false;}
151 /** Loads an aircraft model.
152 @param AircraftPath path to the aircraft directory. For instance:
153 "aircraft". Under aircraft, then, would be directories for various
154 modeled aircraft such as C172/, x15/, etc.
155 @param EnginePath path to the directory under which engine config
156 files are kept, for instance "engine"
157 @param model the name of the aircraft model itself. This file will
158 be looked for in the directory specified in the AircraftPath variable,
159 and in turn under the directory with the same name as the model. For
160 instance: "aircraft/x15/x15.xml"
161 @return true if successful*/
162 bool LoadModel(string AircraftPath, string EnginePath, string model);
164 bool SetEnginePath(string path) {EnginePath = path; return true;}
165 bool SetAircraftPath(string path) {AircraftPath = path; return true;}
167 /// @name Top-level executive State and Model retrieval mechanism
169 /// Returns the FGState pointer.
170 inline FGState* GetState(void) {return State;}
171 /// Returns the FGAtmosphere pointer.
172 inline FGAtmosphere* GetAtmosphere(void) {return Atmosphere;}
173 /// Returns the FGFCS pointer.
174 inline FGFCS* GetFCS(void) {return FCS;}
175 /// Returns the FGPropulsion pointer.
176 inline FGPropulsion* GetPropulsion(void) {return Propulsion;}
177 /// Returns the FGAircraft pointer.
178 inline FGMassBalance* GetMassBalance(void) {return MassBalance;}
179 /// Returns the FGAerodynamics pointer
180 inline FGAerodynamics* GetAerodynamics(void){return Aerodynamics;}
181 /// Returns the FGInertial pointer.
182 inline FGInertial* GetInertial(void) {return Inertial;}
183 /// Returns the FGGroundReactions pointer.
184 inline FGGroundReactions* GetGroundReactions(void) {return GroundReactions;}
185 /// Returns the FGAircraft pointer.
186 inline FGAircraft* GetAircraft(void) {return Aircraft;}
187 /// Returns the FGTranslation pointer.
188 inline FGTranslation* GetTranslation(void) {return Translation;}
189 /// Returns the FGRotation pointer.
190 inline FGRotation* GetRotation(void) {return Rotation;}
191 /// Returns the FGPosition pointer.
192 inline FGPosition* GetPosition(void) {return Position;}
193 /// Returns the FGAuxiliary pointer.
194 inline FGAuxiliary* GetAuxiliary(void) {return Auxiliary;}
195 /// Returns the FGOutput pointer.
196 inline FGOutput* GetOutput(void) {return Output;}
199 /// Retrieves the engine path.
200 inline string GetEnginePath(void) {return EnginePath;}
201 /// Retrieves the aircraft path.
202 inline string GetAircraftPath(void) {return AircraftPath;}
204 FGPropertyManager* GetPropertyManager(void);
214 static unsigned int FDMctr;
217 FGPropertyManager *master;
218 FGPropertyManager *instance;
225 FGAtmosphere* Atmosphere;
227 FGPropulsion* Propulsion;
228 FGMassBalance* MassBalance;
229 FGAerodynamics* Aerodynamics;
230 FGInertial* Inertial;
231 FGGroundReactions* GroundReactions;
232 FGAircraft* Aircraft;
233 FGTranslation* Translation;
234 FGRotation* Rotation;
235 FGPosition* Position;
236 FGAuxiliary* Auxiliary;
239 bool ReadMetrics(FGConfigFile*);
240 bool ReadPropulsion(FGConfigFile*);
241 bool ReadFlightControls(FGConfigFile*);
242 bool ReadAerodynamics(FGConfigFile*);
243 bool ReadUndercarriage(FGConfigFile*);
244 bool ReadPrologue(FGConfigFile*);
245 bool ReadOutput(FGConfigFile*);
248 bool DeAllocate(void);
249 void Debug(int from);
252 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%