src/FDM/JSBSim/FGTank.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGTank.cpp
   4  Author:       Jon Berndt
   5  Date started: 01/21/99
   6  Called by:    FGAircraft
   7
   8  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29 See header file.
  30
  31 HISTORY
  32 --------------------------------------------------------------------------------
  33 01/21/99   JSB   Created
  34
  35 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  36 INCLUDES
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  38
  39 #include "FGTank.h"
  40
  41 static const char *IdSrc = "$Id$";
  42 static const char *IdHdr = ID_TANK;
  43
  44 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  45 CLASS IMPLEMENTATION
  46 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  47
  48 #if !defined ( sgi ) || defined( __GNUC__ )
  49 using std::cerr;
  50 using std::endl;
  51 using std::cout;
  52 #endif
  53
  54 FGTank::FGTank(FGConfigFile* AC_cfg)
  55 {
  56   string type = AC_cfg->GetValue("TYPE");
  57   string token;
  58
  59   if      (type == "FUEL")     Type = ttFUEL;
  60   else if (type == "OXIDIZER") Type = ttOXIDIZER;
  61   else                         Type = ttUNKNOWN;
  62
  63   AC_cfg->GetNextConfigLine();
  64   while ((token = AC_cfg->GetValue()) != string("/AC_TANK")) {
  65     if (token == "XLOC") *AC_cfg >> X;
  66     else if (token == "YLOC") *AC_cfg >> Y;
  67     else if (token == "ZLOC") *AC_cfg >> Z;
  68     else if (token == "RADIUS") *AC_cfg >> Radius;
  69     else if (token == "CAPACITY") *AC_cfg >> Capacity;
  70     else if (token == "CONTENTS") *AC_cfg >> Contents;
  71     else cerr << "Unknown identifier: " << token << " in tank definition." << endl;
  72   }
  73
  74   Selected = true;
  75
  76   if (Capacity != 0) {
  77     PctFull = 100.0*Contents/Capacity;            // percent full; 0 to 100.0
  78   } else {
  79     Contents = 0;
  80     PctFull  = 0;
  81   }
  82
  83   if (debug_lvl > 0) {
  84     cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
  85     cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
  86     cout << "      Tank location (X, Y, Z): " << X << ", " << Y << ", " << Z << endl;
  87     cout << "      Effective radius: " << Radius << " inches" << endl;
  88   }
  89
  90   if (debug_lvl & 2) cout << "Instantiated: FGTank" << endl;
  91 }
  92
  93 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  94
  95 FGTank::~FGTank()
  96 {
  97   if (debug_lvl & 2) cout << "Destroyed:    FGTank" << endl;
  98 }
  99
 100 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 101
 102 double FGTank::Reduce(double used)
 103 {
 104   double shortage;
 105
 106   if (used < Contents) {
 107     Contents -= used;
 108     PctFull = 100.0*Contents/Capacity;
 109     return 0.0;
 110   } else {
 111     shortage = Contents - used;
 112     Contents = 0.0;
 113     PctFull = 0.0;
 114     Selected = false;
 115     return shortage;
 116   }
 117 }
 118
 119 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 120
 121 void FGTank::Debug(void)
 122 {
 123     //TODO: Add your source code here
 124 }
 125