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 };
 169
 170 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 171 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
 172 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 173
 174 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 175 CLASS DOCUMENTATION
 176 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 177
 178 /** JSBSim Base class.
 179     @author Jon S. Berndt
 180     @version $Id$
 181 */
 182
 183 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 184 CLASS DECLARATION
 185 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 186
 187 class FGJSBBase {
 188 public:
 189   /// Constructor for FGJSBBase.
 190   FGJSBBase();
 191
 192   /// Destructor for FGJSBBase.
 193   virtual ~FGJSBBase() {};
 194
 195   /// JSBSim Message structure
 196   typedef struct Msg {
 197     unsigned int fdmId;
 198     unsigned int messageId;
 199     string text;
 200     string subsystem;
 201     enum mType {eText, eInteger, eDouble, eBool} type;
 202     bool bVal;
 203     int  iVal;
 204     double dVal;
 205   } Message;
 206
 207   ///@name JSBSim Enums.
 208   //@{
 209   /// Moments L, M, N
 210   enum {eL     = 1, eM,     eN    };
 211   /// Rates P, Q, R
 212   enum {eP     = 1, eQ,     eR    };
 213   /// Velocities U, V, W
 214   enum {eU     = 1, eV,     eW    };
 215   /// Positions X, Y, Z
 216   enum {eX     = 1, eY,     eZ    };
 217   /// Euler angles Phi, Theta, Psi
 218   enum {ePhi   = 1, eTht,   ePsi  };
 219   /// Stability axis forces, Drag, Side force, Lift
 220   enum {eDrag  = 1, eSide,  eLift };
 221   /// Local frame orientation Roll, Pitch, Yaw
 222   enum {eRoll  = 1, ePitch, eYaw  };
 223   /// Local frame position North, East, Down
 224   enum {eNorth = 1, eEast,  eDown };
 225   //@}
 226
 227   ///@name JSBSim console output highlighting terms.
 228   //@{
 229   /// highlights text
 230   static char highint[5];
 231   /// low intensity text
 232   static char halfint[5];
 233   /// normal intensity text
 234   static char normint[6];
 235   /// resets text properties
 236   static char reset[5];
 237   /// underlines text
 238   static char underon[5];
 239   /// underline off
 240   static char underoff[6];
 241   /// blue text
 242   static char fgblue[6];
 243   /// cyan text
 244   static char fgcyan[6];
 245   /// red text
 246   static char fgred[6];
 247   /// green text
 248   static char fggreen[6];
 249   /// default text
 250   static char fgdef[6];
 251   //@}
 252
 253   ///@name JSBSim Messaging functions
 254   //@{
 255   /** Places a Message structure on the Message queue.
 256       @param msg pointer to a Message structure
 257       @return pointer to a Message structure */
 258   Message* PutMessage(Message* msg);
 259   /** Creates a message with the given text and places it on the queue.
 260       @param text message text
 261       @return pointer to a Message structure */
 262   Message* PutMessage(string text);
 263   /** Creates a message with the given text and boolean value and places it on the queue.
 264       @param text message text
 265       @param bVal boolean value associated with the message
 266       @return pointer to a Message structure */
 267   Message* PutMessage(string text, bool bVal);
 268   /** Creates a message with the given text and integer value and places it on the queue.
 269       @param text message text
 270       @param iVal integer value associated with the message
 271       @return pointer to a Message structure */
 272   Message* PutMessage(string text, int iVal);
 273   /** Creates a message with the given text and double value and places it on the queue.
 274       @param text message text
 275       @param dVal double value associated with the message
 276       @return pointer to a Message structure */
 277   Message* PutMessage(string text, double dVal);
 278   /** Reads the message on the queue (but does not delete it).
 279       @return pointer to a Message structure (or NULL if no mesage) */
 280   Message* ReadMessage(void);
 281   /** Reads the message on the queue and removes it from the queue.
 282       @return pointer to a Message structure (or NULL if no mesage) */
 283   Message* ProcessMessage(void);
 284   //@}
 285   string GetVersion(void) {return JSBSim_version;}
 286
 287 protected:
 288   static Message localMsg;
 289
 290   static queue <Message*> Messages;
 291
 292   virtual void Debug(int from) {};
 293
 294   static short debug_lvl;
 295   static unsigned int frame;
 296   static unsigned int messageId;
 297
 298   static const double radtodeg;
 299   static const double degtorad;
 300   static const double hptoftlbssec;
 301   static const double fpstokts;
 302   static const double ktstofps;
 303   static const double inchtoft;
 304   static const double Reng;         // Specific Gas Constant,ft^2/(sec^2*R)
 305   static const double SHRatio;
 306   static const string needed_cfg_version;
 307   static const string JSBSim_version;
 308 };
 309
 310 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 311 #endif
 312