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 "FGDefs.h"
  40 #include "FGTank.h"
  41
  42 static const char *IdSrc = "$Id$";
  43 static const char *IdHdr = ID_TANK;
  44
  45 extern short debug_lvl;
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 CLASS IMPLEMENTATION
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51 #if !defined ( sgi ) || defined( __GNUC__ )
  52 using std::cerr;
  53 using std::endl;
  54 using std::cout;
  55 #endif
  56
  57 FGTank::FGTank(FGConfigFile* AC_cfg)
  58 {
  59   string type = AC_cfg->GetValue("TYPE");
  60   string token;
  61
  62   if      (type == "FUEL")     Type = ttFUEL;
  63   else if (type == "OXIDIZER") Type = ttOXIDIZER;
  64   else                         Type = ttUNKNOWN;
  65
  66   AC_cfg->GetNextConfigLine();
  67   while ((token = AC_cfg->GetValue()) != "/AC_TANK") {
  68     if (token == "XLOC") *AC_cfg >> X;
  69     else if (token == "YLOC") *AC_cfg >> Y;
  70     else if (token == "ZLOC") *AC_cfg >> Z;
  71     else if (token == "RADIUS") *AC_cfg >> Radius;
  72     else if (token == "CAPACITY") *AC_cfg >> Capacity;
  73     else if (token == "CONTENTS") *AC_cfg >> Contents;
  74     else cerr << "Unknown identifier: " << token << " in tank definition." << endl;
  75   }
  76
  77   Selected = true;
  78
  79   if (Capacity != 0) {
  80     PctFull = 100.0*Contents/Capacity;            // percent full; 0 to 100.0
  81   } else {
  82     Contents = 0;
  83     PctFull  = 0;
  84   }
  85
  86   if (debug_lvl > 0) {
  87     cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
  88     cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
  89     cout << "      Tank location (X, Y, Z): " << X << ", " << Y << ", " << Z << endl;
  90     cout << "      Effective radius: " << Radius << " inches" << endl;
  91   }
  92
  93   if (debug_lvl & 2) cout << "Instantiated: FGTank" << endl;
  94 }
  95
  96 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  97
  98 FGTank::~FGTank()
  99 {
 100   if (debug_lvl & 2) cout << "Destroyed:    FGTank" << endl;
 101 }
 102
 103 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 104
 105 float FGTank::Reduce(float used)
 106 {
 107   float shortage;
 108
 109   if (used < Contents) {
 110     Contents -= used;
 111     PctFull = 100.0*Contents/Capacity;
 112     return 0.0;
 113   } else {
 114     shortage = Contents - used;
 115     Contents = 0.0;
 116     PctFull = 0.0;
 117     Selected = false;
 118     return shortage;
 119   }
 120 }
 121
 122 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 123
 124 void FGTank::Debug(void)
 125 {
 126     //TODO: Add your source code here
 127 }
 128