]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGJSBBase.h
Fix a compile error.
[flightgear.git] / src / FDM / JSBSim / FGJSBBase.h
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2
3  Header:       FGJSBBase.h
4  Author:       Jon S. Berndt
5  Date started: 07/01/01
6
7  ------------- Copyright (C) 2001  Jon S. Berndt (jsb@hal-pc.org) -------------
8
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
12  version.
13
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
17  details.
18
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.
22
23  Further information about the GNU General Public License can also be found on
24  the world wide web at http://www.gnu.org.
25
26 HISTORY
27 --------------------------------------------------------------------------------
28 07/01/01  JSB  Created
29
30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31 SENTRY
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
33
34 #ifndef FGJSBBASE_H
35 #define FGJSBBASE_H
36
37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 INCLUDES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40
41 #ifdef FGFS
42 #  include <simgear/compiler.h>
43 #  include <math.h>
44 #  include <queue>
45 #  include STL_STRING
46
47 SG_USING_STD(string);
48 SG_USING_STD(queue);
49
50 #else
51
52 #  include <queue>
53 #  include <string>
54 #  if defined(sgi) && !defined(__GNUC__)
55 #    include <math.h>
56 #  else
57 #    include <cmath>
58 #  endif
59
60 using std::string;
61 using std::queue;
62 #endif
63
64 #ifndef M_PI 
65 #  include <simgear/constants.h>
66 #  define M_PI SG_PI
67 #endif
68
69 #ifdef __FreeBSD__ // define gcvt on FreeBSD
70
71 #include <stdio.h>
72
73 static char *gcvt(double number, size_t ndigit, char *buf)
74 {
75      sprintf(buf, "%f", number);
76      return buf;
77 }
78 #endif
79
80 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
81 DEFINITIONS
82 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
83
84 #define ID_JSBBASE "$Id$"
85
86 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
87 FORWARD DECLARATIONS
88 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
89
90 enum eParam {
91   FG_UNDEF = 0,
92   FG_TIME,
93   FG_QBAR,
94   FG_WINGAREA,
95   FG_WINGSPAN,
96   FG_CBAR,
97   FG_ALPHA,
98   FG_ALPHADOT,
99   FG_BETA,
100   FG_ABETA,
101   FG_BETADOT,
102   FG_PHI,
103   FG_THT,
104   FG_PSI,
105   FG_PITCHRATE,
106   FG_ROLLRATE,
107   FG_YAWRATE,
108   FG_AEROP,
109   FG_AEROQ,
110   FG_AEROR,
111   FG_CL_SQRD,
112   FG_MACH,
113   FG_ALTITUDE,
114   FG_BI2VEL,
115   FG_CI2VEL,
116   FG_ELEVATOR_POS,
117   FG_AELEVATOR_POS,
118   FG_NELEVATOR_POS,
119   FG_AILERON_POS,
120   FG_AAILERON_POS,
121   FG_NAILERON_POS,
122   FG_LEFT_AILERON_POS,
123   FG_ALEFT_AILERON_POS,
124   FG_NLEFT_AILERON_POS,
125   FG_RIGHT_AILERON_POS,
126   FG_ARIGHT_AILERON_POS,
127   FG_NRIGHT_AILERON_POS,
128   FG_RUDDER_POS,
129   FG_ARUDDER_POS,
130   FG_NRUDDER_POS,
131   FG_SPDBRAKE_POS,
132   FG_NSPDBRAKE_POS,
133   FG_SPOILERS_POS,
134   FG_NSPOILERS_POS,
135   FG_FLAPS_POS,
136   FG_NFLAPS_POS,
137   FG_ELEVATOR_CMD,
138   FG_AILERON_CMD,
139   FG_RUDDER_CMD,
140   FG_SPDBRAKE_CMD,
141   FG_SPOILERS_CMD,
142   FG_FLAPS_CMD,
143   FG_THROTTLE_CMD,
144   FG_THROTTLE_POS,
145   FG_MIXTURE_CMD,
146   FG_MIXTURE_POS,
147   FG_MAGNETO_CMD,
148   FG_STARTER_CMD,
149   FG_ACTIVE_ENGINE,
150   FG_HOVERB,
151   FG_PITCH_TRIM_CMD,
152   FG_YAW_TRIM_CMD,
153   FG_ROLL_TRIM_CMD,
154   FG_LEFT_BRAKE_CMD,
155   FG_CENTER_BRAKE_CMD,
156   FG_RIGHT_BRAKE_CMD,
157   FG_SET_LOGGING,
158   FG_ALPHAH,
159   FG_ALPHAW,
160   FG_LBARH,     //normalized horizontal tail arm
161   FG_LBARV,     //normalized vertical tail arm
162   FG_HTAILAREA,
163   FG_VTAILAREA,
164   FG_VBARH,    //horizontal tail volume 
165   FG_VBARV,     //vertical tail volume 
166   FG_GEAR_CMD,
167   FG_GEAR_POS,
168   FG_HYSTPARM,
169   AP_ELEVATOR_CMD,
170   AP_AILERON_CMD,
171   AP_RUDDER_CMD,
172   AP_THROTTLE_CMD,
173   AP_SET_ATTITUDE,
174   AP_SET_ALTITUDE,
175   AP_SET_HEADING,
176   AP_SET_AIRSPEED,
177   AP_ACQUIRE_ATTITUDE,
178   AP_ACQUIRE_ALTITUDE,
179   AP_ACQUIRE_HEADING,
180   AP_ACQUIRE_AIRSPEED,
181   AP_ATTITUDE_HOLD_ON,
182   AP_ALTITUDE_HOLD_ON,
183   AP_HEADING_HOLD_ON,
184   AP_AIRSPEED_HOLD_ON,
185   AP_WINGSLEVEL_HOLD_ON
186 };
187
188 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
189 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
190 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
191
192 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
193 CLASS DOCUMENTATION
194 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
195
196 /** JSBSim Base class.
197     @author Jon S. Berndt
198     @version $Id$
199 */
200
201 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
202 CLASS DECLARATION
203 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
204
205 class FGJSBBase {
206 public:
207   /// Constructor for FGJSBBase.
208   FGJSBBase();
209
210   /// Destructor for FGJSBBase.
211   virtual ~FGJSBBase() {};
212
213   /// JSBSim Message structure
214   typedef struct Msg {
215     unsigned int fdmId;
216     unsigned int messageId;
217     string text;
218     string subsystem;
219     enum mType {eText, eInteger, eDouble, eBool} type;
220     bool bVal;
221     int  iVal;
222     double dVal;
223   } Message;
224
225   ///@name JSBSim Enums.
226   //@{
227   /// Moments L, M, N
228   enum {eL     = 1, eM,     eN    };
229   /// Rates P, Q, R
230   enum {eP     = 1, eQ,     eR    };
231   /// Velocities U, V, W
232   enum {eU     = 1, eV,     eW    };
233   /// Positions X, Y, Z
234   enum {eX     = 1, eY,     eZ    };
235   /// Euler angles Phi, Theta, Psi
236   enum {ePhi   = 1, eTht,   ePsi  };
237   /// Stability axis forces, Drag, Side force, Lift
238   enum {eDrag  = 1, eSide,  eLift };
239   /// Local frame orientation Roll, Pitch, Yaw
240   enum {eRoll  = 1, ePitch, eYaw  };
241   /// Local frame position North, East, Down
242   enum {eNorth = 1, eEast,  eDown };
243   //@}
244   
245   ///@name JSBSim console output highlighting terms.
246   //@{
247   /// highlights text
248   static char highint[5];
249   /// low intensity text
250   static char halfint[5];
251   /// normal intensity text
252   static char normint[6];
253   /// resets text properties
254   static char reset[5];
255   /// underlines text
256   static char underon[5];
257   /// underline off
258   static char underoff[6];
259   /// blue text
260   static char fgblue[6];
261   /// cyan text
262   static char fgcyan[6];
263   /// red text
264   static char fgred[6];
265   /// green text
266   static char fggreen[6];
267   /// default text
268   static char fgdef[6];
269   //@}
270
271   ///@name JSBSim Messaging functions
272   //@{
273   /** Places a Message structure on the Message queue.
274       @param msg pointer to a Message structure
275       @return pointer to a Message structure */
276   Message* PutMessage(Message* msg);
277   /** Creates a message with the given text and places it on the queue.
278       @param text message text
279       @return pointer to a Message structure */
280   Message* PutMessage(string text);
281   /** Creates a message with the given text and boolean value and places it on the queue.
282       @param text message text
283       @param bVal boolean value associated with the message
284       @return pointer to a Message structure */
285   Message* PutMessage(string text, bool bVal);
286   /** Creates a message with the given text and integer value and places it on the queue.
287       @param text message text
288       @param iVal integer value associated with the message
289       @return pointer to a Message structure */
290   Message* PutMessage(string text, int iVal);
291   /** Creates a message with the given text and double value and places it on the queue.
292       @param text message text
293       @param dVal double value associated with the message
294       @return pointer to a Message structure */
295   Message* PutMessage(string text, double dVal);
296   /** Reads the message on the queue (but does not delete it).
297       @return pointer to a Message structure (or NULL if no mesage) */
298   Message* ReadMessage(void);
299   /** Reads the message on the queue and removes it from the queue.
300       @return pointer to a Message structure (or NULL if no mesage) */
301   Message* ProcessMessage(void);
302   //@}
303   string GetVersion(void) {return JSBSim_version;}
304
305 protected:
306   static Message localMsg;
307   
308   static queue <Message*> Messages;
309
310   virtual void Debug(int from) {};
311
312   static short debug_lvl;
313   static unsigned int frame;
314   static unsigned int messageId;
315   
316   static const double radtodeg;
317   static const double degtorad;
318   static const double hptoftlbssec;
319   static const double psftoinhg;
320   static const double fpstokts;
321   static const double ktstofps;
322   static const double inchtoft;
323   static const double in3tom3;
324   static const double Reng;         // Specific Gas Constant,ft^2/(sec^2*R)
325   static const double SHRatio;
326   static const string needed_cfg_version;
327   static const string JSBSim_version;
328 };
329
330 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
331 #endif
332