]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGTank.cpp
Restructuring some of the initialization code.
[flightgear.git] / 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 token;
57   
58   type = AC_cfg->GetValue("TYPE");
59
60   if      (type == "FUEL")     Type = ttFUEL;
61   else if (type == "OXIDIZER") Type = ttOXIDIZER;
62   else                         Type = ttUNKNOWN;
63   
64   AC_cfg->GetNextConfigLine();
65   while ((token = AC_cfg->GetValue()) != string("/AC_TANK")) {
66     if (token == "XLOC") *AC_cfg >> X;
67     else if (token == "YLOC") *AC_cfg >> Y;
68     else if (token == "ZLOC") *AC_cfg >> Z;
69     else if (token == "RADIUS") *AC_cfg >> Radius;
70     else if (token == "CAPACITY") *AC_cfg >> Capacity;
71     else if (token == "CONTENTS") *AC_cfg >> Contents;
72     else cerr << "Unknown identifier: " << token << " in tank definition." << endl;
73   }
74   
75   Selected = true;
76
77   if (Capacity != 0) {
78     PctFull = 100.0*Contents/Capacity;            // percent full; 0 to 100.0
79   } else {
80     Contents = 0;
81     PctFull  = 0;
82   }     
83
84   Debug(0);
85 }
86
87 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88
89 FGTank::~FGTank()
90 {
91   Debug(1);
92 }
93
94 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
95
96 double FGTank::Reduce(double used)
97 {
98   double shortage = Contents - used;
99
100   if (shortage >= 0) {
101     Contents -= used;
102     PctFull = 100.0*Contents/Capacity;
103   } else {
104     Contents = 0.0;
105     PctFull = 0.0;
106     Selected = false;
107   }
108   return shortage;
109 }
110
111 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
112 //    The bitmasked value choices are as follows:
113 //    unset: In this case (the default) JSBSim would only print
114 //       out the normally expected messages, essentially echoing
115 //       the config files as they are read. If the environment
116 //       variable is not set, debug_lvl is set to 1 internally
117 //    0: This requests JSBSim not to output any messages
118 //       whatsoever.
119 //    1: This value explicity requests the normal JSBSim
120 //       startup messages
121 //    2: This value asks for a message to be printed out when
122 //       a class is instantiated
123 //    4: When this value is set, a message is displayed when a
124 //       FGModel object executes its Run() method
125 //    8: When this value is set, various runtime state variables
126 //       are printed out periodically
127 //    16: When set various parameters are sanity checked and
128 //       a message is printed out when they go out of bounds
129
130 void FGTank::Debug(int from)
131 {
132   if (debug_lvl <= 0) return;
133
134   if (debug_lvl & 1) { // Standard console startup message output
135     if (from == 0) { // Constructor
136       cout << "      " << type << " tank holds " << Capacity << " lbs. " << type << endl;
137       cout << "      currently at " << PctFull << "% of maximum capacity" << endl;
138       cout << "      Tank location (X, Y, Z): " << X << ", " << Y << ", " << Z << endl;
139       cout << "      Effective radius: " << Radius << " inches" << endl;
140     }
141   }
142   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
143     if (from == 0) cout << "Instantiated: FGTank" << endl;
144     if (from == 1) cout << "Destroyed:    FGTank" << endl;
145   }
146   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
147   }
148   if (debug_lvl & 8 ) { // Runtime state variables
149   }
150   if (debug_lvl & 16) { // Sanity checking
151   }
152   if (debug_lvl & 64) {
153     if (from == 0) { // Constructor
154       cout << IdSrc << endl;
155       cout << IdHdr << endl;
156     }
157   }
158 }
159