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
  49 # ifndef M_PI
  50 #  include <simgear/constants.h>
  51 #  define M_PI SG_PI
  52 # endif
  53
  54 #else
  55
  56 #  include <queue>
  57 #  include <string>
  58 #  if defined(sgi) && !defined(__GNUC__)
  59 #    include <math.h>
  60 #  else
  61 #    include <cmath>
  62 #  endif
  63
  64 using std::string;
  65
  66 # ifndef M_PI
  67 #  define M_PI 3.14159265358979323846
  68 # endif
  69
  70 #endif
  71
  72 #if !defined(WIN32) || defined(__GNUC__)
  73 using std::max;
  74 #endif
  75
  76 #ifdef __FreeBSD__ // define gcvt on FreeBSD
  77
  78 #include <stdio.h>
  79
  80 static char *gcvt(double number, size_t ndigit, char *buf)
  81 {
  82      sprintf(buf, "%f", number);
  83      return buf;
  84 }
  85 #endif
  86
  87 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  88 DEFINITIONS
  89 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  90
  91 #define ID_JSBBASE "$Id$"
  92
  93 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  94 FORWARD DECLARATIONS
  95 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  96
  97 namespace JSBSim {
  98
  99 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 100 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
 101 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 102
 103 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 104 CLASS DOCUMENTATION
 105 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 106
 107 /** JSBSim Base class.
 108     @author Jon S. Berndt
 109     @version $Id$
 110 */
 111
 112 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 113 CLASS DECLARATION
 114 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 115
 116 class FGJSBBase {
 117 public:
 118   /// Constructor for FGJSBBase.
 119   FGJSBBase();
 120
 121   /// Destructor for FGJSBBase.
 122   virtual ~FGJSBBase() {};
 123
 124   /// JSBSim Message structure
 125   typedef struct Msg {
 126     unsigned int fdmId;
 127     unsigned int messageId;
 128     string text;
 129     string subsystem;
 130     enum mType {eText, eInteger, eDouble, eBool} type;
 131     bool bVal;
 132     int  iVal;
 133     double dVal;
 134   } Message;
 135
 136   ///@name JSBSim Enums.
 137   //@{
 138   /// Moments L, M, N
 139   enum {eL     = 1, eM,     eN    };
 140   /// Rates P, Q, R
 141   enum {eP     = 1, eQ,     eR    };
 142   /// Velocities U, V, W
 143   enum {eU     = 1, eV,     eW    };
 144   /// Positions X, Y, Z
 145   enum {eX     = 1, eY,     eZ    };
 146   /// Euler angles Phi, Theta, Psi
 147   enum {ePhi   = 1, eTht,   ePsi  };
 148   /// Stability axis forces, Drag, Side force, Lift
 149   enum {eDrag  = 1, eSide,  eLift };
 150   /// Local frame orientation Roll, Pitch, Yaw
 151   enum {eRoll  = 1, ePitch, eYaw  };
 152   /// Local frame position North, East, Down
 153   enum {eNorth = 1, eEast,  eDown };
 154   //@}
 155
 156   ///@name JSBSim console output highlighting terms.
 157   //@{
 158   /// highlights text
 159   static char highint[5];
 160   /// low intensity text
 161   static char halfint[5];
 162   /// normal intensity text
 163   static char normint[6];
 164   /// resets text properties
 165   static char reset[5];
 166   /// underlines text
 167   static char underon[5];
 168   /// underline off
 169   static char underoff[6];
 170   /// blue text
 171   static char fgblue[6];
 172   /// cyan text
 173   static char fgcyan[6];
 174   /// red text
 175   static char fgred[6];
 176   /// green text
 177   static char fggreen[6];
 178   /// default text
 179   static char fgdef[6];
 180   //@}
 181
 182   ///@name JSBSim Messaging functions
 183   //@{
 184   /** Places a Message structure on the Message queue.
 185       @param msg pointer to a Message structure
 186       @return pointer to a Message structure */
 187   Message* PutMessage(Message* msg);
 188   /** Creates a message with the given text and places it on the queue.
 189       @param text message text
 190       @return pointer to a Message structure */
 191   Message* PutMessage(string text);
 192   /** Creates a message with the given text and boolean value and places it on the queue.
 193       @param text message text
 194       @param bVal boolean value associated with the message
 195       @return pointer to a Message structure */
 196   Message* PutMessage(string text, bool bVal);
 197   /** Creates a message with the given text and integer value and places it on the queue.
 198       @param text message text
 199       @param iVal integer value associated with the message
 200       @return pointer to a Message structure */
 201   Message* PutMessage(string text, int iVal);
 202   /** Creates a message with the given text and double value and places it on the queue.
 203       @param text message text
 204       @param dVal double value associated with the message
 205       @return pointer to a Message structure */
 206   Message* PutMessage(string text, double dVal);
 207   /** Reads the message on the queue (but does not delete it).
 208       @return pointer to a Message structure (or NULL if no mesage) */
 209   Message* ReadMessage(void);
 210   /** Reads the message on the queue and removes it from the queue.
 211       @return pointer to a Message structure (or NULL if no mesage) */
 212   Message* ProcessMessage(void);
 213   //@}
 214   string GetVersion(void) {return JSBSim_version;}
 215
 216   void disableHighLighting(void);
 217
 218 protected:
 219   static Message localMsg;
 220
 221   static std::queue <Message*> Messages;
 222
 223   virtual void Debug(int from) {};
 224
 225   static short debug_lvl;
 226   static unsigned int frame;
 227   static unsigned int messageId;
 228
 229   static const double radtodeg;
 230   static const double degtorad;
 231   static const double hptoftlbssec;
 232   static const double psftoinhg;
 233   static const double fpstokts;
 234   static const double ktstofps;
 235   static const double inchtoft;
 236   static const double in3tom3;
 237   static const double Reng;         // Specific Gas Constant,ft^2/(sec^2*R)
 238   static const double SHRatio;
 239   static const string needed_cfg_version;
 240   static const string JSBSim_version;
 241 };
 242 }
 243 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 244 #endif
 245