1 // TankProperties.cxx -- expose (fuel)-tank properties
3 // Written by Torsten Dreyer, started January 2011.
5 // Copyright (C) 2011 Torsten Dreyer - Torsten (at) t3r _dot_ de
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 #include "TankProperties.hxx"
28 #include <simgear/math/SGMath.hxx>
29 #include <Main/fg_props.hxx>
31 static const double LBS_PER_KG = 2.20462262;
32 static const double KG_PER_LBS = 1.0/LBS_PER_KG;
33 static const double USGAL_PER_M3 = 1000.0/3.785411784;
34 static const double M3_PER_USGAL = 1.0/USGAL_PER_M3;
35 static const double IMPGAL_PER_M3 = 1000.0/4.54609;
36 static const double M3_PER_IMPGAL = 1.0/IMPGAL_PER_M3;
38 TankProperties::TankProperties(SGPropertyNode_ptr rootNode ) :
43 _tiedProperties.setRoot( rootNode );
44 _tiedProperties.Tie("level-kg", this, &TankProperties::getContent_kg, &TankProperties::setContent_kg );
45 _tiedProperties.Tie("density-kgpm3", this, &TankProperties::getDensity_kgpm3, &TankProperties::setDensity_kgpm3 );
46 _tiedProperties.Tie("capacity-m3", this, &TankProperties::getCapacity_m3, &TankProperties::setCapacity_m3 );
47 _tiedProperties.Tie("level-m3", this, &TankProperties::getContent_m3, &TankProperties::setContent_m3 );
48 _tiedProperties.Tie("level-norm", this, &TankProperties::getContent_norm, &TankProperties::setContent_norm );
50 _tiedProperties.Tie("density-ppg", this, &TankProperties::getDensity_ppg, &TankProperties::setDensity_ppg );
51 _tiedProperties.Tie("level-lbs", this, &TankProperties::getContent_lbs, &TankProperties::setContent_lbs );
52 _tiedProperties.Tie("level-gal_us", this, &TankProperties::getContent_gal_us, &TankProperties::setContent_gal_us );
53 _tiedProperties.Tie("level-gal_imp", this, &TankProperties::getContent_gal_imp, &TankProperties::setContent_gal_imp );
54 _tiedProperties.Tie("capacity-gal_us", this, &TankProperties::getCapacity_gal_us, &TankProperties::setCapacity_gal_us );
55 _tiedProperties.Tie("capacity-gal_imp", this, &TankProperties::getCapacity_gal_imp, &TankProperties::setCapacity_gal_imp );
58 TankProperties::~TankProperties()
62 double TankProperties::getContent_kg() const
67 void TankProperties::setContent_kg( double value )
72 double TankProperties::getDensity_kgpm3() const
74 return _density_kgpm3;
77 void TankProperties::setDensity_kgpm3( double value )
79 _density_kgpm3 = value;
82 double TankProperties::getDensity_ppg() const
84 return _density_kgpm3 * LBS_PER_KG / USGAL_PER_M3;
87 void TankProperties::setDensity_ppg( double value )
89 _density_kgpm3 = value * KG_PER_LBS / M3_PER_USGAL;
92 double TankProperties::getContent_lbs() const
94 return _content_kg * LBS_PER_KG;
97 void TankProperties::setContent_lbs( double value )
99 _content_kg = value * KG_PER_LBS;
102 double TankProperties::getContent_m3() const
104 return _density_kgpm3 > SGLimitsd::min() ? _content_kg / _density_kgpm3 : 0.0;
107 void TankProperties::setContent_m3( double value )
109 // ugly hack to allow setting of a volumetric content without having the density
110 _content_kg = value * (_density_kgpm3>0.0?_density_kgpm3:755.0);
113 double TankProperties::getContent_gal_us() const
115 return getContent_m3() * USGAL_PER_M3;
118 void TankProperties::setContent_gal_us( double value )
120 setContent_m3( value * M3_PER_USGAL );
123 double TankProperties::getContent_gal_imp() const
125 return getContent_m3() * IMPGAL_PER_M3;
128 void TankProperties::setContent_gal_imp( double value )
130 setContent_m3( value * M3_PER_IMPGAL );
133 double TankProperties::getCapacity_m3() const
138 void TankProperties::setCapacity_m3( double value )
140 _capacity_m3 = value;
143 double TankProperties::getCapacity_gal_us() const
145 return _capacity_m3 * USGAL_PER_M3;
148 void TankProperties::setCapacity_gal_us( double value )
150 _capacity_m3 = value * M3_PER_USGAL;
153 double TankProperties::getCapacity_gal_imp() const
155 return _capacity_m3 * IMPGAL_PER_M3;
158 void TankProperties::setCapacity_gal_imp( double value )
160 _capacity_m3 = value * M3_PER_IMPGAL;
163 double TankProperties::getContent_norm() const
165 return _capacity_m3 > SGLimitsd::min() ? getContent_m3() / _capacity_m3 : 0.0;
168 void TankProperties::setContent_norm( double value )
170 setContent_m3(_capacity_m3 * value);
173 TankPropertiesList::TankPropertiesList( SGPropertyNode_ptr rootNode )
175 // we don't have a global rule how many tanks we support, so I assume eight.
176 // Because hard coded values suck, make it settable by a property.
177 // If tanks were configured, use that number
178 int n = rootNode->nChildren();
179 if( n == 0 ) n = rootNode->getIntValue( "numtanks", 8 );
180 for( int i = 0; i < n; i++ ) {
181 push_back( new TankProperties( rootNode->getChild( "tank", i, true ) ) );
184 _tiedProperties.setRoot( rootNode );
185 _tiedProperties.Tie("total-fuel-kg", this, &TankPropertiesList::getTotalContent_kg );
186 _tiedProperties.Tie("total-fuel-lbs", this, &TankPropertiesList::getTotalContent_lbs );
187 _tiedProperties.Tie("total-fuel-gal_us", this, &TankPropertiesList::getTotalContent_gal_us );
188 _tiedProperties.Tie("total-fuel-gals", this, &TankPropertiesList::getTotalContent_gal_us );
189 _tiedProperties.Tie("total-fuel-gal_imp", this, &TankPropertiesList::getTotalContent_gal_imp );
190 _tiedProperties.Tie("total-fuel-norm", this, &TankPropertiesList::getTotalContent_norm );
193 double TankPropertiesList::getTotalContent_lbs() const
196 for( const_iterator it = begin(); it != end(); ++it )
197 value += (*it)->getContent_lbs();
201 double TankPropertiesList::getTotalContent_kg() const
204 for( const_iterator it = begin(); it != end(); ++it )
205 value += (*it)->getContent_kg();
209 double TankPropertiesList::getTotalContent_gal_us() const
212 for( const_iterator it = begin(); it != end(); ++it )
213 value += (*it)->getContent_gal_us();
217 double TankPropertiesList::getTotalContent_gal_imp() const
220 for( const_iterator it = begin(); it != end(); ++it )
221 value += (*it)->getContent_gal_imp();
225 double TankPropertiesList::getTotalContent_m3() const
228 for( const_iterator it = begin(); it != end(); ++it )
229 value += (*it)->getContent_m3();
233 double TankPropertiesList::getTotalContent_norm() const
235 double content = 0.0;
236 double capacity = 0.0;
237 for( const_iterator it = begin(); it != end(); ++it ) {
238 content += (*it)->getContent_m3();
239 capacity += (*it)->getCapacity_m3();
241 return capacity > SGLimitsd::min() ? content / capacity : 0.0;