src/FDM/JSBsim/FGTranslation.h

   1 /*******************************************************************************
   2
   3  Header:       FGTranslation.h
   4  Author:       Jon Berndt
   5  Date started: 12/02/98
   6
   7  ------------- Copyright (C) 1999  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 12/02/98   JSB   Created
  29
  30 ********************************************************************************
  31 COMMENTS, REFERENCES,  and NOTES
  32 ********************************************************************************
  33 [1] Cooke, Zyda, Pratt, and McGhee, "NPSNET: Flight Simulation Dynamic Modeling
  34     Using Quaternions", Presence, Vol. 1, No. 4, pp. 404-420  Naval Postgraduate
  35     School, January 1994
  36 [2] D. M. Henderson, "Euler Angles, Quaternions, and Transformation Matrices",
  37     JSC 12960, July 1977
  38 [3] Richard E. McFarland, "A Standard Kinematic Model for Flight Simulation at
  39     NASA-Ames", NASA CR-2497, January 1975
  40 [4] Barnes W. McCormick, "Aerodynamics, Aeronautics, and Flight Mechanics",
  41     Wiley & Sons, 1979 ISBN 0-471-03032-5
  42 [5] Bernard Etkin, "Dynamics of Flight, Stability and Control", Wiley & Sons,
  43     1982 ISBN 0-471-08936-2
  44
  45   The order of rotations used in this class corresponds to a 3-2-1 sequence,
  46   or Y-P-R, or Z-Y-X, if you prefer.
  47
  48 ********************************************************************************
  49 SENTRY
  50 *******************************************************************************/
  51
  52 #ifndef FGTRANSLATION_H
  53 #define FGTRANSLATION_H
  54
  55 /*******************************************************************************
  56 INCLUDES
  57 *******************************************************************************/
  58
  59 #ifdef FGFS
  60 #  include <Include/compiler.h>
  61 #  ifdef FG_HAVE_STD_INCLUDES
  62 #    include <cmath>
  63 #  else
  64 #    include <math.h>
  65 #  endif
  66 #else
  67 #  include <cmath>
  68 #endif
  69
  70 #include "FGModel.h"
  71
  72 using namespace std;
  73
  74 /*******************************************************************************
  75 CLASS DECLARATION
  76 *******************************************************************************/
  77
  78 class FGTranslation : public FGModel
  79 {
  80 public:
  81    FGTranslation(FGFDMExec*);
  82    ~FGTranslation(void);
  83
  84    inline float GetU(void) {return U;}
  85    inline float GetV(void) {return V;}
  86    inline float GetW(void) {return W;}
  87
  88    inline float GetUdot(void) {return Udot;}
  89    inline float GetVdot(void) {return Vdot;}
  90    inline float GetWdot(void) {return Wdot;}
  91
  92    inline float Getalpha(void) {return alpha;}
  93    inline float Getbeta (void) {return beta; }
  94    inline float Getgamma(void) {return gamma;}
  95
  96    inline void SetU(float tt) {U = tt;}
  97    inline void SetV(float tt) {V = tt;}
  98    inline void SetW(float tt) {W = tt;}
  99
 100    inline void SetUVW(float t1, float t2, float t3) {U=t1; V=t2; W=t3;}
 101
 102    inline void Setalpha(float tt) {alpha = tt;}
 103    inline void Setbeta (float tt) {beta  = tt;}
 104    inline void Setgamma(float tt) {gamma = tt;}
 105
 106    inline void SetABG(float t1, float t2, float t3) {alpha=t1; beta=t2; gamma=t3;}
 107
 108    bool Run(void);
 109
 110 protected:
 111
 112 private:
 113   float U, V, W;                 // Body frame velocities owned by FGTranslation
 114   float P, Q, R;
 115   float Vt, qbar;
 116   float Udot, Vdot, Wdot;
 117   float lastUdot, lastVdot, lastWdot;
 118   float phi, tht, psi;
 119   float Fx, Fy, Fz;
 120   float Mass, dt;
 121   float alpha, beta, gamma;
 122   float rho;
 123
 124   void GetState(void);
 125   void PutState(void);
 126 };
 127
 128 /******************************************************************************/
 129 #endif