src/FDM/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 <simgear/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 #else
  57 #  include <string>
  58 #  include <fstream>
  59 #endif
  60
  61 #include "FGDefs.h"
  62 #include "FGInitialCondition.h"
  63
  64 /*******************************************************************************
  65 DEFINES
  66 *******************************************************************************/
  67
  68 using namespace std;
  69
  70 /*******************************************************************************
  71 CLASS DECLARATION
  72 *******************************************************************************/
  73
  74 class FGFDMExec;
  75
  76 class FGState
  77 {
  78 public:
  79    FGState(FGFDMExec*);
  80   ~FGState(void);
  81
  82   bool Reset(string, string);
  83   void Initialize(float, float, float, float, float, float, float, float, float);
  84   void Initialize(FGInitialCondition *FGIC);
  85   bool StoreData(string);
  86   bool DumpData(string);
  87   bool DisplayData(void);
  88
  89   inline float GetVt(void) {return Vt;}
  90
  91   inline float Getlatitude(void) {return latitude;}
  92   inline float Getlongitude(void) {return longitude;}
  93   inline float GetGeodeticLat(void) {return GeodeticLat;}
  94
  95   inline float Getadot(void) {return adot;}
  96   inline float Getbdot(void) {return bdot;}
  97
  98   inline float GetLocalAltitudeOverRunway(void) {return LocalAltitudeOverRunway;}
  99   inline float Geth(void) {return h;}
 100   inline float Geta(void) {return a;}
 101   inline float GetMach(void) {return Mach;}
 102
 103   inline float Getsim_time(void) {return sim_time;}
 104   inline float Getdt(void) {return dt;}
 105
 106   inline float Getqbar(void) {return qbar;}
 107
 108   inline void SetVt(float tt) {Vt = tt;}
 109
 110   inline void Setlatitude(float tt) {latitude = tt;}
 111   inline void Setlongitude(float tt) {longitude = tt;}
 112   inline void SetGeodeticLat(float tt) {GeodeticLat = tt;}
 113
 114   inline void Setadot(float tt) {adot = tt;}
 115   inline void Setbdot(float tt) {bdot = tt;}
 116
 117   inline void Setqbar(float tt) {qbar = tt;}
 118
 119   inline void SetLocalAltitudeOverRunway(float tt) {LocalAltitudeOverRunway = tt;}
 120   inline void Seth(float tt) {h = tt;}
 121   inline void Seta(float tt) {a = tt;}
 122   inline void SetMach(float tt) {Mach = tt;}
 123
 124   inline float Setsim_time(float tt) {sim_time = tt; return sim_time;}
 125   inline void  Setdt(float tt) {dt = tt;}
 126
 127   inline float IncrTime(void) {sim_time+=dt;return sim_time;}
 128
 129
 130 private:
 131
 132   float Vt;                         // Total velocity
 133   float latitude, longitude;        // position
 134   float GeodeticLat;                // Geodetic Latitude
 135   float adot, bdot;                 // alpha dot and beta dot
 136   float h, a;                       // altitude above sea level, speed of sound
 137   float qbar;                       // dynamic pressure
 138   float sim_time, dt;
 139   float Mach;                       // Mach number
 140
 141   FGFDMExec* FDMExec;
 142   float LocalAltitudeOverRunway;
 143
 144 protected:
 145
 146 };
 147
 148 /******************************************************************************/
 149 #endif