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 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  70 DEFINITIONS
  71 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  72
  73 #define ID_JSBBASE "$Id$"
  74
  75 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 FORWARD DECLARATIONS
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  78
  79 enum eParam {
  80   FG_UNDEF = 0,
  81   FG_TIME,
  82   FG_QBAR,
  83   FG_WINGAREA,
  84   FG_WINGSPAN,
  85   FG_CBAR,
  86   FG_ALPHA,
  87   FG_ALPHADOT,
  88   FG_BETA,
  89   FG_ABETA,
  90   FG_BETADOT,
  91   FG_PHI,
  92   FG_THT,
  93   FG_PSI,
  94   FG_PITCHRATE,
  95   FG_ROLLRATE,
  96   FG_YAWRATE,
  97   FG_CL_SQRD,
  98   FG_MACH,
  99   FG_ALTITUDE,
 100   FG_BI2VEL,
 101   FG_CI2VEL,
 102   FG_ELEVATOR_POS,
 103   FG_AILERON_POS,
 104   FG_RUDDER_POS,
 105   FG_SPDBRAKE_POS,
 106   FG_SPOILERS_POS,
 107   FG_FLAPS_POS,
 108   FG_ELEVATOR_CMD,
 109   FG_AILERON_CMD,
 110   FG_RUDDER_CMD,
 111   FG_SPDBRAKE_CMD,
 112   FG_SPOILERS_CMD,
 113   FG_FLAPS_CMD,
 114   FG_THROTTLE_CMD,
 115   FG_THROTTLE_POS,
 116   FG_MIXTURE_CMD,
 117   FG_MIXTURE_POS,
 118   FG_MAGNETO_CMD,
 119   FG_STARTER_CMD,
 120   FG_ACTIVE_ENGINE,
 121   FG_HOVERB,
 122   FG_PITCH_TRIM_CMD,
 123   FG_YAW_TRIM_CMD,
 124   FG_ROLL_TRIM_CMD,
 125   FG_LEFT_BRAKE_CMD,
 126   FG_CENTER_BRAKE_CMD,
 127   FG_RIGHT_BRAKE_CMD,
 128   FG_SET_LOGGING,
 129   FG_ALPHAH,
 130   FG_ALPHAW,
 131   FG_LBARH,     //normalized horizontal tail arm
 132   FG_LBARV,     //normalized vertical tail arm
 133   FG_HTAILAREA,
 134   FG_VTAILAREA,
 135   FG_VBARH,    //horizontal tail volume
 136   FG_VBARV     //vertical tail volume
 137 };
 138
 139 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 140 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
 141 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 142
 143 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 144 CLASS DOCUMENTATION
 145 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 146
 147 /** JSBSim Base class.
 148     @author Jon S. Berndt
 149     @version $Id$
 150 */
 151
 152 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 153 CLASS DECLARATION
 154 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 155
 156 class FGJSBBase {
 157 public:
 158   /// Constructor for FGJSBBase.
 159   FGJSBBase();
 160
 161   /// Destructor for FGJSBBase.
 162   virtual ~FGJSBBase() {};
 163
 164   /// JSBSim Message structure
 165   struct Message {
 166     unsigned int fdmId;
 167     unsigned int messageId;
 168     string text;
 169     string subsystem;
 170     enum mType {eText, eInteger, eDouble, eBool} type;
 171     bool bVal;
 172     int  iVal;
 173     double dVal;
 174   };
 175
 176   ///@name JSBSim Enums.
 177   //@{
 178   /// Moments L, M, N
 179   enum {eL     = 1, eM,     eN    };
 180   /// Rates P, Q, R
 181   enum {eP     = 1, eQ,     eR    };
 182   /// Velocities U, V, W
 183   enum {eU     = 1, eV,     eW    };
 184   /// Positions X, Y, Z
 185   enum {eX     = 1, eY,     eZ    };
 186   /// Euler angles Phi, Theta, Psi
 187   enum {ePhi   = 1, eTht,   ePsi  };
 188   /// Stability axis forces, Drag, Side force, Lift
 189   enum {eDrag  = 1, eSide,  eLift };
 190   /// Local frame orientation Roll, Pitch, Yaw
 191   enum {eRoll  = 1, ePitch, eYaw  };
 192   /// Local frame position North, East, Down
 193   enum {eNorth = 1, eEast,  eDown };
 194   //@}
 195
 196   ///@name JSBSim console output highlighting terms.
 197   //@{
 198   /// highlights text
 199   static char highint[5];
 200   /// low intensity text
 201   static char halfint[5];
 202   /// normal intensity text
 203   static char normint[6];
 204   /// resets text properties
 205   static char reset[5];
 206   /// underlines text
 207   static char underon[5];
 208   /// underline off
 209   static char underoff[6];
 210   /// blue text
 211   static char fgblue[6];
 212   /// cyan text
 213   static char fgcyan[6];
 214   /// red text
 215   static char fgred[6];
 216   /// green text
 217   static char fggreen[6];
 218   /// default text
 219   static char fgdef[6];
 220   //@}
 221
 222   ///@name JSBSim Messaging functions
 223   //@{
 224   /** Places a Message structure on the Message queue.
 225       @param msg pointer to a Message structure
 226       @return pointer to a Message structure */
 227   struct Message* PutMessage(struct Message* msg);
 228   /** Creates a message with the given text and places it on the queue.
 229       @param text message text
 230       @return pointer to a Message structure */
 231   struct Message* PutMessage(string text);
 232   /** Creates a message with the given text and boolean value and places it on the queue.
 233       @param text message text
 234       @param bVal boolean value associated with the message
 235       @return pointer to a Message structure */
 236   struct Message* PutMessage(string text, bool bVal);
 237   /** Creates a message with the given text and integer value and places it on the queue.
 238       @param text message text
 239       @param iVal integer value associated with the message
 240       @return pointer to a Message structure */
 241   struct Message* PutMessage(string text, int iVal);
 242   /** Creates a message with the given text and double value and places it on the queue.
 243       @param text message text
 244       @param dVal double value associated with the message
 245       @return pointer to a Message structure */
 246   struct Message* PutMessage(string text, double dVal);
 247   /** Reads the message on the queue (but does not delete it).
 248       @return pointer to a Message structure (or NULL if no mesage) */
 249   struct Message* ReadMessage(void);
 250   /** Reads the message on the queue and removes it from the queue.
 251       @return pointer to a Message structure (or NULL if no mesage) */
 252   struct Message* ProcessMessage(void);
 253   //@}
 254
 255 protected:
 256   static struct Message localMsg;
 257
 258   static queue <struct Message*> Messages;
 259
 260   virtual void Debug(void) {};
 261
 262   static short debug_lvl;
 263   static int frame;
 264   static unsigned int messageId;
 265
 266   static const double radtodeg;
 267   static const double degtorad;
 268   static const double hptoftlbssec;
 269   static const double fpstokts;
 270   static const double ktstofps;
 271   static const double inchtoft;
 272   static const double Reng;         // Specific Gas Constant,ft^2/(sec^2*R)
 273   static const double SHRatio;
 274   static const string needed_cfg_version;
 275   static const string JSBSim_version;
 276 };
 277
 278 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 279 #endif
 280