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 <simgear/sg_inlines.h>
30 #include <Main/fg_props.hxx>
32 static const double LBS_PER_KG = 2.20462262;
33 static const double KG_PER_LBS = 1.0/LBS_PER_KG;
34 static const double USGAL_PER_M3 = 1000.0/3.785411784;
35 static const double M3_PER_USGAL = 1.0/USGAL_PER_M3;
36 static const double IMPGAL_PER_M3 = 1000.0/4.54609;
37 static const double M3_PER_IMPGAL = 1.0/IMPGAL_PER_M3;
39 TankProperties::TankProperties(SGPropertyNode_ptr rootNode ) :
45 _tiedProperties.setRoot( rootNode );
46 _tiedProperties.Tie("level-kg", this, &TankProperties::getContent_kg, &TankProperties::setContent_kg );
47 _tiedProperties.Tie("density-kgpm3", this, &TankProperties::getDensity_kgpm3, &TankProperties::setDensity_kgpm3 );
48 _tiedProperties.Tie("capacity-m3", this, &TankProperties::getCapacity_m3, &TankProperties::setCapacity_m3 );
49 _tiedProperties.Tie("unusable-m3", this, &TankProperties::getUnusable_m3, &TankProperties::setUnusable_m3 );
50 _tiedProperties.Tie("level-m3", this, &TankProperties::getContent_m3, &TankProperties::setContent_m3 );
51 _tiedProperties.Tie("level-norm", this, &TankProperties::getContent_norm, &TankProperties::setContent_norm );
53 _tiedProperties.Tie("density-ppg", this, &TankProperties::getDensity_ppg, &TankProperties::setDensity_ppg );
54 _tiedProperties.Tie("level-lbs", this, &TankProperties::getContent_lbs, &TankProperties::setContent_lbs );
55 _tiedProperties.Tie("level-gal_us", this, &TankProperties::getContent_gal_us, &TankProperties::setContent_gal_us );
56 _tiedProperties.Tie("level-gal_imp", this, &TankProperties::getContent_gal_imp, &TankProperties::setContent_gal_imp );
58 _tiedProperties.Tie("capacity-gal_us", this, &TankProperties::getCapacity_gal_us, &TankProperties::setCapacity_gal_us );
59 _tiedProperties.Tie("unusable-gal_us", this, &TankProperties::getUnusable_gal_us, &TankProperties::setUnusable_gal_us );
61 _tiedProperties.Tie("capacity-gal_imp", this, &TankProperties::getCapacity_gal_imp, &TankProperties::setCapacity_gal_imp );
62 _tiedProperties.Tie("unusable-gal_imp", this, &TankProperties::getUnusable_gal_imp, &TankProperties::setUnusable_gal_imp );
64 _tiedProperties.Tie("empty", this, &TankProperties::getEmpty );
67 TankProperties::~TankProperties()
71 void TankProperties::unbind()
73 _tiedProperties.Untie();
76 double TankProperties::getContent_kg() const
81 void TankProperties::setContent_kg( double value )
83 _content_kg = SG_MAX2<double>(value, 0.0);
86 double TankProperties::getDensity_kgpm3() const
88 return _density_kgpm3;
91 void TankProperties::setDensity_kgpm3( double value )
93 _density_kgpm3 = SG_MAX2<double>(value, 0.0);
96 double TankProperties::getDensity_ppg() const
98 return _density_kgpm3 * LBS_PER_KG / USGAL_PER_M3;
101 void TankProperties::setDensity_ppg( double value )
103 _density_kgpm3 = SG_MAX2<double>(value * KG_PER_LBS / M3_PER_USGAL, 0.0);
106 double TankProperties::getContent_lbs() const
108 return _content_kg * LBS_PER_KG;
111 void TankProperties::setContent_lbs( double value )
113 _content_kg = SG_MAX2<double>(value * KG_PER_LBS, 0.0);
116 double TankProperties::getContent_m3() const
118 return _density_kgpm3 > SGLimitsd::min() ? _content_kg / _density_kgpm3 : 0.0;
121 void TankProperties::setContent_m3( double value )
123 // ugly hack to allow setting of a volumetric content without having the density
124 _content_kg = SG_MAX2<double>(value * (_density_kgpm3>0.0?_density_kgpm3:755.0), 0.0);
127 double TankProperties::getContent_gal_us() const
129 return getContent_m3() * USGAL_PER_M3;
132 void TankProperties::setContent_gal_us( double value )
134 setContent_m3( value * M3_PER_USGAL );
137 double TankProperties::getContent_gal_imp() const
139 return getContent_m3() * IMPGAL_PER_M3;
142 void TankProperties::setContent_gal_imp( double value )
144 setContent_m3( value * M3_PER_IMPGAL );
147 double TankProperties::getCapacity_m3() const
152 void TankProperties::setCapacity_m3( double value )
154 _capacity_m3 = SG_MAX2<double>(value, 0.0);
157 double TankProperties::getCapacity_gal_us() const
159 return _capacity_m3 * USGAL_PER_M3;
162 void TankProperties::setCapacity_gal_us( double value )
164 _capacity_m3 = SG_MAX2<double>(value * M3_PER_USGAL, 0.0);
167 double TankProperties::getCapacity_gal_imp() const
169 return _capacity_m3 * IMPGAL_PER_M3;
172 void TankProperties::setCapacity_gal_imp( double value )
174 _capacity_m3 = SG_MAX2<double>(value * M3_PER_IMPGAL, 0.0);
177 double TankProperties::getUnusable_m3() const
182 void TankProperties::setUnusable_m3( double value )
184 _unusable_m3 = SG_MAX2<double>(value, 0.0);
187 double TankProperties::getUnusable_gal_us() const
189 return _unusable_m3 * USGAL_PER_M3;
192 void TankProperties::setUnusable_gal_us( double value )
194 _unusable_m3 = SG_MAX2<double>(value * M3_PER_USGAL, 0.0);
198 double TankProperties::getUnusable_gal_imp() const
200 return _unusable_m3 * IMPGAL_PER_M3;
203 void TankProperties::setUnusable_gal_imp( double value )
205 _unusable_m3 = SG_MAX2<double>(value * M3_PER_IMPGAL, 0.0);
208 double TankProperties::getContent_norm() const
210 return _capacity_m3 > SGLimitsd::min() ? getContent_m3() / _capacity_m3 : 0.0;
213 void TankProperties::setContent_norm( double value )
215 setContent_m3(_capacity_m3 * value);
218 bool TankProperties::getEmpty() const
220 return getContent_m3() <= _unusable_m3;
223 TankPropertiesList::TankPropertiesList( SGPropertyNode_ptr rootNode )
225 // we don't have a global rule how many tanks we support, so I assume eight.
226 // Because hard coded values suck, make it settable by a property.
227 // If tanks were configured, use that number
228 int n = rootNode->getChildren("tank").size();
229 if( n == 0 ) n = rootNode->getIntValue( "numtanks", 8 );
230 for( int i = 0; i < n; i++ ) {
231 push_back( new TankProperties( rootNode->getChild( "tank", i, true ) ) );
234 _tiedProperties.setRoot( rootNode );
235 _tiedProperties.Tie("total-fuel-kg", this, &TankPropertiesList::getTotalContent_kg );
236 _tiedProperties.Tie("total-fuel-lbs", this, &TankPropertiesList::getTotalContent_lbs );
237 _tiedProperties.Tie("total-fuel-gal_us", this, &TankPropertiesList::getTotalContent_gal_us );
238 _tiedProperties.Tie("total-fuel-gals", this, &TankPropertiesList::getTotalContent_gal_us );
239 _tiedProperties.Tie("total-fuel-gal_imp", this, &TankPropertiesList::getTotalContent_gal_imp );
240 _tiedProperties.Tie("total-fuel-norm", this, &TankPropertiesList::getTotalContent_norm );
243 double TankPropertiesList::getTotalContent_lbs() const
246 for( const_iterator it = begin(); it != end(); ++it )
247 value += (*it)->getContent_lbs();
251 double TankPropertiesList::getTotalContent_kg() const
254 for( const_iterator it = begin(); it != end(); ++it )
255 value += (*it)->getContent_kg();
259 double TankPropertiesList::getTotalContent_gal_us() const
262 for( const_iterator it = begin(); it != end(); ++it )
263 value += (*it)->getContent_gal_us();
267 double TankPropertiesList::getTotalContent_gal_imp() const
270 for( const_iterator it = begin(); it != end(); ++it )
271 value += (*it)->getContent_gal_imp();
275 double TankPropertiesList::getTotalContent_m3() const
278 for( const_iterator it = begin(); it != end(); ++it )
279 value += (*it)->getContent_m3();
283 double TankPropertiesList::getTotalContent_norm() const
285 double content = 0.0;
286 double capacity = 0.0;
287 for( const_iterator it = begin(); it != end(); ++it ) {
288 content += (*it)->getContent_m3();
289 capacity += (*it)->getCapacity_m3();
291 return capacity > SGLimitsd::min() ? content / capacity : 0.0;
294 void TankPropertiesList::unbind()
296 for( const_iterator it = begin(); it != end(); ++it ) {
299 _tiedProperties.Untie();