1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7 ------------- Copyright (C) 2001 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.
27 --------------------------------------------------------------------------------
30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 # include <simgear/compiler.h>
54 # if defined(sgi) && !defined(__GNUC__)
65 # include <simgear/constants.h>
69 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
71 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
73 #define ID_JSBBASE "$Id$"
75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
134 FG_LBARH, //normalized horizontal tail arm
135 FG_LBARV, //normalized vertical tail arm
138 FG_VBARH, //horizontal tail volume
139 FG_VBARV //vertical tail volume
142 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
143 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
144 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
146 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
148 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
150 /** JSBSim Base class.
151 @author Jon S. Berndt
155 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
157 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
161 /// Constructor for FGJSBBase.
164 /// Destructor for FGJSBBase.
165 virtual ~FGJSBBase() {};
167 /// JSBSim Message structure
170 unsigned int messageId;
173 enum mType {eText, eInteger, eDouble, eBool} type;
179 ///@name JSBSim Enums.
182 enum {eL = 1, eM, eN };
184 enum {eP = 1, eQ, eR };
185 /// Velocities U, V, W
186 enum {eU = 1, eV, eW };
187 /// Positions X, Y, Z
188 enum {eX = 1, eY, eZ };
189 /// Euler angles Phi, Theta, Psi
190 enum {ePhi = 1, eTht, ePsi };
191 /// Stability axis forces, Drag, Side force, Lift
192 enum {eDrag = 1, eSide, eLift };
193 /// Local frame orientation Roll, Pitch, Yaw
194 enum {eRoll = 1, ePitch, eYaw };
195 /// Local frame position North, East, Down
196 enum {eNorth = 1, eEast, eDown };
199 ///@name JSBSim console output highlighting terms.
202 static char highint[5];
203 /// low intensity text
204 static char halfint[5];
205 /// normal intensity text
206 static char normint[6];
207 /// resets text properties
208 static char reset[5];
210 static char underon[5];
212 static char underoff[6];
214 static char fgblue[6];
216 static char fgcyan[6];
218 static char fgred[6];
220 static char fggreen[6];
222 static char fgdef[6];
225 ///@name JSBSim Messaging functions
227 /** Places a Message structure on the Message queue.
228 @param msg pointer to a Message structure
229 @return pointer to a Message structure */
230 struct Message* PutMessage(struct Message* msg);
231 /** Creates a message with the given text and places it on the queue.
232 @param text message text
233 @return pointer to a Message structure */
234 struct Message* PutMessage(string text);
235 /** Creates a message with the given text and boolean value and places it on the queue.
236 @param text message text
237 @param bVal boolean value associated with the message
238 @return pointer to a Message structure */
239 struct Message* PutMessage(string text, bool bVal);
240 /** Creates a message with the given text and integer value and places it on the queue.
241 @param text message text
242 @param iVal integer value associated with the message
243 @return pointer to a Message structure */
244 struct Message* PutMessage(string text, int iVal);
245 /** Creates a message with the given text and double value and places it on the queue.
246 @param text message text
247 @param dVal double value associated with the message
248 @return pointer to a Message structure */
249 struct Message* PutMessage(string text, double dVal);
250 /** Reads the message on the queue (but does not delete it).
251 @return pointer to a Message structure (or NULL if no mesage) */
252 struct Message* ReadMessage(void);
253 /** Reads the message on the queue and removes it from the queue.
254 @return pointer to a Message structure (or NULL if no mesage) */
255 struct Message* ProcessMessage(void);
259 static struct Message localMsg;
261 static queue <struct Message*> Messages;
263 virtual void Debug(void) {};
265 static short debug_lvl;
266 static unsigned int frame;
267 static unsigned int messageId;
269 static const double radtodeg;
270 static const double degtorad;
271 static const double hptoftlbssec;
272 static const double fpstokts;
273 static const double ktstofps;
274 static const double inchtoft;
275 static const double Reng; // Specific Gas Constant,ft^2/(sec^2*R)
276 static const double SHRatio;
277 static const string needed_cfg_version;
278 static const string JSBSim_version;
281 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%