1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7 ------------- Copyright (C) 1999 Jon S. Berndt (jsb@hal-pc.org) -------------
9 This program is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free Software
11 Foundation; either version 2 of the License, or (at your option) any later
14 This program is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 You should have received a copy of the GNU General Public License along with
20 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
21 Place - Suite 330, Boston, MA 02111-1307, USA.
23 Further information about the GNU General Public License can also be found on
24 the world wide web at http://www.gnu.org.
26 FUNCTIONAL DESCRIPTION
27 --------------------------------------------------------------------------------
30 --------------------------------------------------------------------------------
33 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
35 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
45 # include <simgear/compiler.h>
46 # ifdef SG_HAVE_STD_INCLUDES
52 # if defined(sgi) && !defined(__GNUC__) && (_COMPILER_VERSION < 740)
61 #include "FGJSBBase.h"
62 #include "FGInitialCondition.h"
63 #include "FGMatrix33.h"
64 #include "FGColumnVector3.h"
65 #include "FGQuaternion.h"
66 #include "FGFDMExec.h"
67 #include "FGAtmosphere.h"
69 #include "FGPropagate.h"
70 #include "FGAuxiliary.h"
71 #include "FGAerodynamics.h"
73 #include "FGAircraft.h"
74 #include "FGGroundReactions.h"
75 #include "FGPropulsion.h"
77 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
79 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
81 #define ID_STATE "$Id$"
83 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
85 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
89 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
93 /** Encapsulates the calculation of aircraft state.
98 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
100 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
102 class FGState : public FGJSBBase
106 @param Executive a pointer to the parent executive object */
111 /** Initializes the simulation state based on parameters from an Initial Conditions object.
112 @param FGIC pointer to an initial conditions object.
113 @see FGInitialConditions.
115 void Initialize(FGInitialCondition *FGIC);
117 /// Returns the simulation time in seconds.
118 inline double Getsim_time(void) const { return sim_time; }
119 /// Returns the simulation delta T.
120 inline double Getdt(void) { return dt; }
122 /// Suspends the simulation and sets the delta T to zero.
123 inline void Suspend(void) {saved_dt = dt; dt = 0.0;}
124 /// Resumes the simulation by resetting delta T to the correct value.
125 inline void Resume(void) {dt = saved_dt;}
127 /** Sets the current sim time.
128 @param cur_time the current time
129 @return the current time.
131 inline double Setsim_time(double cur_time) {
136 /** Sets the integration time step for the simulation executive.
137 @param delta_t the time step in seconds.
139 inline void Setdt(double delta_t) { dt = delta_t; }
141 /** Increments the simulation time.
142 @return the new simulation time.
144 inline double IncrTime(void) {
149 /** Calculates and returns the stability-to-body axis transformation matrix.
150 @return a reference to the stability-to-body transformation matrix.
152 FGMatrix33& GetTs2b(void);
154 /** Calculates and returns the body-to-stability axis transformation matrix.
155 @return a reference to the stability-to-body transformation matrix.
157 FGMatrix33& GetTb2s(void);
159 /** Prints a summary of simulator state (speed, altitude,
162 void ReportState(void);
175 FGAircraft* Aircraft;
176 FGPropagate* Propagate;
178 FGAtmosphere* Atmosphere;
180 FGAerodynamics* Aerodynamics;
181 FGGroundReactions* GroundReactions;
182 FGPropulsion* Propulsion;
183 FGAuxiliary* Auxiliary;
184 FGPropertyManager* PropertyManager;
186 void Debug(int from);
189 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%