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 #include <stdio.h>
  48 #include <fstream.h>
  49 #include "FGDefs.h"
  50
  51 /*******************************************************************************
  52 DEFINES
  53 *******************************************************************************/
  54
  55 /*******************************************************************************
  56 CLASS DECLARATION
  57 *******************************************************************************/
  58
  59 class FGFDMExec;
  60 class FGState
  61 {
  62 public:
  63    FGState(FGFDMExec*);
  64   ~FGState(void);
  65
  66   bool Reset(char*);
  67   bool StoreData(char*);
  68   bool DumpData(char*);
  69   bool DisplayData(void);
  70
  71   inline float GetVt(void) {return Vt;}
  72
  73   inline float Getlatitude(void) {return latitude;}
  74   inline float Getlongitude(void) {return longitude;}
  75   inline float GetGeodeticLat(void) {return GeodeticLat;}
  76
  77   inline float Getadot(void) {return adot;}
  78   inline float Getbdot(void) {return bdot;}
  79
  80   inline float Geth(void) {return h;}
  81   inline float Geta(void) {return a;}
  82   inline float GetMach(void) {return Mach;}
  83
  84   inline float Getsim_time(void) {return sim_time;}
  85   inline float Getdt(void) {return dt;}
  86
  87   inline float Getqbar(void) {return qbar;}
  88
  89   inline void SetVt(float tt) {Vt = tt;}
  90
  91   inline void Setlatitude(float tt) {latitude = tt;}
  92   inline void Setlongitude(float tt) {longitude = tt;}
  93   inline void SetGeodeticLat(float tt) {GeodeticLat = tt;}
  94
  95   inline void Setadot(float tt) {adot = tt;}
  96   inline void Setbdot(float tt) {bdot = tt;}
  97
  98   inline void Setqbar(float tt) {qbar = tt;}
  99
 100   inline void Seth(float tt) {h = tt;}
 101   inline void Seta(float tt) {a = tt;}
 102   inline void SetMach(float tt) {Mach = tt;}
 103
 104   inline float Setsim_time(float tt) {sim_time = tt; return sim_time;}
 105   inline void  Setdt(float tt) {dt = tt;}
 106
 107   inline float IncrTime(void) {sim_time+=dt;return sim_time;}
 108
 109 private:
 110
 111   float Vt;                         // Total velocity
 112   float latitude, longitude;        // position
 113   float GeodeticLat;                // Geodetic Latitude
 114   float adot, bdot;                 // alpha dot and beta dot
 115   float h, a;                       // altitude above sea level, speed of sound
 116   float qbar;                       // dynamic pressure
 117   float sim_time, dt;
 118   float Mach;                       // Mach number
 119
 120   FGFDMExec* FDMExec;
 121
 122 protected:
 123
 124 };
 125
 126 /******************************************************************************/
 127 #endif