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 #if !defined ( sgi ) || defined( __GNUC__ )
  42 using std::cerr;
  43 using std::endl;
  44 using std::cout;
  45 #endif
  46
  47 namespace JSBSim {
  48
  49 static const char *IdSrc = "$Id$";
  50 static const char *IdHdr = ID_TANK;
  51
  52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 CLASS IMPLEMENTATION
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56 FGTank::FGTank(FGConfigFile* AC_cfg)
  57 {
  58   string token;
  59
  60   type = AC_cfg->GetValue("TYPE");
  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()) != string("/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   Debug(0);
  87 }
  88
  89 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  90
  91 FGTank::~FGTank()
  92 {
  93   Debug(1);
  94 }
  95
  96 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  97
  98 double FGTank::Reduce(double used)
  99 {
 100   double shortage = Contents - used;
 101
 102   if (shortage >= 0) {
 103     Contents -= used;
 104     PctFull = 100.0*Contents/Capacity;
 105   } else {
 106     Contents = 0.0;
 107     PctFull = 0.0;
 108     Selected = false;
 109   }
 110   return shortage;
 111 }
 112
 113 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 114 //    The bitmasked value choices are as follows:
 115 //    unset: In this case (the default) JSBSim would only print
 116 //       out the normally expected messages, essentially echoing
 117 //       the config files as they are read. If the environment
 118 //       variable is not set, debug_lvl is set to 1 internally
 119 //    0: This requests JSBSim not to output any messages
 120 //       whatsoever.
 121 //    1: This value explicity requests the normal JSBSim
 122 //       startup messages
 123 //    2: This value asks for a message to be printed out when
 124 //       a class is instantiated
 125 //    4: When this value is set, a message is displayed when a
 126 //       FGModel object executes its Run() method
 127 //    8: When this value is set, various runtime state variables
 128 //       are printed out periodically
 129 //    16: When set various parameters are sanity checked and
 130 //       a message is printed out when they go out of bounds
 131
 132 void FGTank::Debug(int from)
 133 {
 134   if (debug_lvl <= 0) return;
 135
 136   if (debug_lvl & 1) { // Standard console startup message output
 137     if (from == 0) { // Constructor
 138       cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
 139       cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
 140       cout << "      Tank location (X, Y, Z): " << X << ", " << Y << ", " << Z << endl;
 141       cout << "      Effective radius: " << Radius << " inches" << endl;
 142     }
 143   }
 144   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 145     if (from == 0) cout << "Instantiated: FGTank" << endl;
 146     if (from == 1) cout << "Destroyed:    FGTank" << endl;
 147   }
 148   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 149   }
 150   if (debug_lvl & 8 ) { // Runtime state variables
 151   }
 152   if (debug_lvl & 16) { // Sanity checking
 153   }
 154   if (debug_lvl & 64) {
 155     if (from == 0) { // Constructor
 156       cout << IdSrc << endl;
 157       cout << IdHdr << endl;
 158     }
 159   }
 160 }
 161 }