JSBsim/FGTank.h

   1 /*******************************************************************************
   2
   3  Header:       FGTank.h
   4  Author:       Jon S. Berndt
   5  Date started: 01/21/99
   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 simulates
  30 a generic Tank.
  31
  32 HISTORY
  33 --------------------------------------------------------------------------------
  34 01/21/99   JSB   Created
  35
  36 ********************************************************************************
  37 SENTRY
  38 *******************************************************************************/
  39
  40 #ifndef FGTank_H
  41 #define FGTank_H
  42
  43 /*******************************************************************************
  44 INCLUDES
  45 *******************************************************************************/
  46 #ifdef FGFS
  47 #  include <Include/compiler.h>
  48 #  include STL_STRING
  49 #  ifdef FG_HAVE_STD_INCLUDES
  50 #    include <fstream>
  51 #  else
  52 #    include <fstream.h>
  53 #  endif
  54    FG_USING_STD(string);
  55 #else
  56 #  include <string>
  57 #  include <fstream>
  58 #endif
  59
  60 /*******************************************************************************
  61 DEFINES
  62 *******************************************************************************/
  63
  64 /*******************************************************************************
  65 CLASS DECLARATION
  66 *******************************************************************************/
  67
  68 class FGTank
  69 {
  70 public:
  71   FGTank(ifstream&);
  72   ~FGTank(void);
  73
  74   float Reduce(float);
  75   int GetType(void) {return Type;}
  76   bool GetSelected(void) {return Selected;}
  77   float GetPctFull(void) {return PctFull;}
  78   float GetContents(void) {return Contents;}
  79
  80   enum TankType {ttUNKNOWN, ttFUEL, ttOXIDIZER};
  81
  82 private:
  83   TankType Type;
  84   float X, Y, Z;
  85   float Capacity;
  86   float Radius;
  87   float PctFull;
  88   float Contents;
  89   bool  Selected;
  90
  91 protected:
  92 };
  93
  94 /******************************************************************************/
  95 #endif