JSBsim/FGState.h

   1 /*******************************************************************************
   2
   3  Header:       FGState.h
   4  Author:       Jon S. Berndt
   5  Date started: 11/17/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 FUNCTIONAL DESCRIPTION
  27 --------------------------------------------------------------------------------
  28
  29 Based on Flightgear code, which is based on LaRCSim. This class wraps all
  30 global state variables (such as velocity, position, orientation, etc.).
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 11/17/98   JSB   Created
  35
  36 ********************************************************************************
  37 SENTRY
  38 *******************************************************************************/
  39
  40 #ifndef FGSTATE_H
  41 #define FGSTATE_H
  42
  43 /*******************************************************************************
  44 INCLUDES
  45 *******************************************************************************/
  46
  47 #ifdef FGFS
  48 #  include <Include/compiler.h>
  49 #  include STL_STRING
  50 #  ifdef FG_HAVE_STD_INCLUDES
  51 #    include <fstream>
  52 #  else
  53 #    include <fstream.h>
  54 #  endif
  55    FG_USING_STD(string);
  56 #  ifdef FG_HAVE_NATIVE_SGI_COMPILERS
  57      FG_USING_NAMESPACE(std);
  58 #  endif
  59 #else
  60 #  include <string>
  61 #  include <fstream>
  62 #endif
  63
  64 #include "FGDefs.h"
  65
  66 /*******************************************************************************
  67 DEFINES
  68 *******************************************************************************/
  69
  70 /*******************************************************************************
  71 CLASS DECLARATION
  72 *******************************************************************************/
  73
  74 class FGFDMExec;
  75 class FGState
  76 {
  77 public:
  78    FGState(FGFDMExec*);
  79   ~FGState(void);
  80
  81   bool Reset(string, string);
  82   bool StoreData(string);
  83   bool DumpData(string);
  84   bool DisplayData(void);
  85
  86   inline float GetVt(void) {return Vt;}
  87
  88   inline float Getlatitude(void) {return latitude;}
  89   inline float Getlongitude(void) {return longitude;}
  90   inline float GetGeodeticLat(void) {return GeodeticLat;}
  91
  92   inline float Getadot(void) {return adot;}
  93   inline float Getbdot(void) {return bdot;}
  94
  95   inline float Geth(void) {return h;}
  96   inline float Geta(void) {return a;}
  97   inline float GetMach(void) {return Mach;}
  98
  99   inline float Getsim_time(void) {return sim_time;}
 100   inline float Getdt(void) {return dt;}
 101
 102   inline float Getqbar(void) {return qbar;}
 103
 104   inline void SetVt(float tt) {Vt = tt;}
 105
 106   inline void Setlatitude(float tt) {latitude = tt;}
 107   inline void Setlongitude(float tt) {longitude = tt;}
 108   inline void SetGeodeticLat(float tt) {GeodeticLat = tt;}
 109
 110   inline void Setadot(float tt) {adot = tt;}
 111   inline void Setbdot(float tt) {bdot = tt;}
 112
 113   inline void Setqbar(float tt) {qbar = tt;}
 114
 115   inline void Seth(float tt) {h = tt;}
 116   inline void Seta(float tt) {a = tt;}
 117   inline void SetMach(float tt) {Mach = tt;}
 118
 119   inline float Setsim_time(float tt) {sim_time = tt; return sim_time;}
 120   inline void  Setdt(float tt) {dt = tt;}
 121
 122   inline float IncrTime(void) {sim_time+=dt;return sim_time;}
 123
 124 private:
 125
 126   float Vt;                         // Total velocity
 127   float latitude, longitude;        // position
 128   float GeodeticLat;                // Geodetic Latitude
 129   float adot, bdot;                 // alpha dot and beta dot
 130   float h, a;                       // altitude above sea level, speed of sound
 131   float qbar;                       // dynamic pressure
 132   float sim_time, dt;
 133   float Mach;                       // Mach number
 134
 135   FGFDMExec* FDMExec;
 136
 137 protected:
 138
 139 };
 140
 141 /******************************************************************************/
 142 #endif