src/FDM/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
  47 #ifdef FGFS
  48 #  include <simgear/compiler.h>
  49 #endif
  50
  51 #include <string>
  52 #include "FGConfigFile.h"
  53
  54 /*******************************************************************************
  55 DEFINES
  56 *******************************************************************************/
  57
  58 /*******************************************************************************
  59 CLASS DECLARATION
  60 *******************************************************************************/
  61
  62 class FGTank
  63 {
  64 public:
  65   FGTank(FGConfigFile*);
  66   ~FGTank(void);
  67
  68   float Reduce(float);
  69   int GetType(void) {return Type;}
  70   bool GetSelected(void) {return Selected;}
  71   float GetPctFull(void) {return PctFull;}
  72   float GetContents(void) {return Contents;}
  73   float inline GetX(void) {return X;}
  74   float inline GetY(void) {return Y;}
  75   float inline GetZ(void) {return Z;}
  76
  77   enum TankType {ttUNKNOWN, ttFUEL, ttOXIDIZER};
  78
  79 private:
  80   TankType Type;
  81   float X, Y, Z;
  82   float Capacity;
  83   float Radius;
  84   float PctFull;
  85   float Contents;
  86   bool  Selected;
  87
  88 protected:
  89 };
  90
  91 /******************************************************************************/
  92 #endif