1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4 Date started: 09/28/2004
5 Purpose: XML element class
8 ------------- Copyright (C) 2001 Jon S. Berndt (jon@jsbsim.org) -------------
10 This program is free software; you can redistribute it and/or modify it under
11 the terms of the GNU Lesser General Public License as published by the Free Software
12 Foundation; either version 2 of the License, or (at your option) any later
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 Lesser General Public License for more
20 You should have received a copy of the GNU Lesser 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.
24 Further information about the GNU Lesser General Public License can also be found on
25 the world wide web at http://www.gnu.org.
27 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
31 #include "FGXMLElement.h"
36 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 static const char *IdSrc = "$Id$";
43 static const char *IdHdr = ID_XMLELEMENT;
45 bool Element::converterIsInitialized = false;
46 map <string, map <string, double> > Element::convert;
48 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
52 Element::Element(string nm)
58 if (!converterIsInitialized) {
59 converterIsInitialized = true;
60 // convert ["from"]["to"] = factor, so: from * factor = to
62 convert["M"]["FT"] = 3.2808399;
63 convert["FT"]["M"] = 1.0/convert["M"]["FT"];
64 convert["FT"]["IN"] = 12.0;
65 convert["IN"]["FT"] = 1.0/convert["FT"]["IN"];
66 convert["IN"]["M"] = convert["IN"]["FT"] * convert["FT"]["M"];
67 convert["M"]["IN"] = convert["M"]["FT"] * convert["FT"]["IN"];
69 convert["M2"]["FT2"] = convert["M"]["FT"]*convert["M"]["FT"];
70 convert["FT2"]["M2"] = 1.0/convert["M2"]["FT2"];
71 convert["M2"]["IN2"] = convert["M"]["IN"]*convert["M"]["IN"];
72 convert["IN2"]["M2"] = 1.0/convert["M2"]["IN2"];
73 convert["FT2"]["IN2"] = 144.0;
74 convert["IN2"]["FT2"] = 1.0/convert["FT2"]["IN2"];
76 convert["IN3"]["CC"] = 16.387064;
77 convert["CC"]["IN3"] = 1.0/convert["IN3"]["CC"];
78 convert["FT3"]["IN3"] = 1728.0;
79 convert["IN3"]["FT3"] = 1.0/convert["FT3"]["IN3"];
80 convert["M3"]["FT3"] = 35.3146667;
81 convert["FT3"]["M3"] = 1.0/convert["M3"]["FT3"];
82 convert["LTR"]["IN3"] = 61.0237441;
83 convert["IN3"]["LTR"] = 1.0/convert["LTR"]["IN3"];
85 convert["LBS"]["KG"] = 0.45359237;
86 convert["KG"]["LBS"] = 1.0/convert["LBS"]["KG"];
87 convert["SLUG"]["KG"] = 14.59390;
88 convert["KG"]["SLUG"] = 1.0/convert["SLUG"]["KG"];
90 convert["SLUG*FT2"]["KG*M2"] = 1.35594;
91 convert["KG*M2"]["SLUG*FT2"] = 1.0/convert["SLUG*FT2"]["KG*M2"];
93 convert["RAD"]["DEG"] = 360.0/(2.0*3.1415926);
94 convert["DEG"]["RAD"] = 1.0/convert["RAD"]["DEG"];
96 convert["LBS/FT"]["N/M"] = 14.5939;
97 convert["N/M"]["LBS/FT"] = 1.0/convert["LBS/FT"]["N/M"];
99 convert["LBS/FT/SEC"]["N/M/SEC"] = 14.5939;
100 convert["N/M/SEC"]["LBS/FT/SEC"] = 1.0/convert["LBS/FT/SEC"]["N/M/SEC"];
101 // Damping force (Square Law)
102 convert["LBS/FT2/SEC2"]["N/M2/SEC2"] = 47.880259;
103 convert["N/M2/SEC2"]["LBS/FT2/SEC2"] = 1.0/convert["LBS/FT2/SEC2"]["N/M2/SEC2"];
105 convert["WATTS"]["HP"] = 0.001341022;
106 convert["HP"]["WATTS"] = 1.0/convert["WATTS"]["HP"];
108 convert["N"]["LBS"] = 0.22482;
109 convert["LBS"]["N"] = 1.0/convert["N"]["LBS"];
111 convert["KTS"]["FT/SEC"] = 1.68781;
112 convert["FT/SEC"]["KTS"] = 1.0/convert["KTS"]["FT/SEC"];
113 convert["M/S"]["FT/S"] = 3.2808399;
114 convert["FT/S"]["M/S"] = 1.0/convert["M/S"]["FT/S"];
116 convert["FT*LBS"]["N*M"] = 1.35581795;
117 convert["N*M"]["FT*LBS"] = 1/convert["FT*LBS"]["N*M"];
119 convert["M4*SEC/KG"]["FT4*SEC/SLUG"] = convert["M"]["FT"]*convert["M"]["FT"]*
120 convert["M"]["FT"]*convert["M"]["FT"]/convert["KG"]["SLUG"];
121 convert["FT4*SEC/SLUG"]["M4*SEC/KG"] =
122 1.0/convert["M4*SEC/KG"]["FT4*SEC/SLUG"];
124 convert["INHG"]["PSF"] = 70.7180803;
125 convert["PSF"]["INHG"] = 1.0/convert["INHG"]["PSF"];
126 convert["ATM"]["INHG"] = 29.9246899;
127 convert["INHG"]["ATM"] = 1.0/convert["ATM"]["INHG"];
128 convert["PSI"]["INHG"] = 2.03625437;
129 convert["INHG"]["PSI"] = 1.0/convert["PSI"]["INHG"];
130 convert["INHG"]["PA"] = 3386.0; // inches Mercury to pascals
131 convert["PA"]["INHG"] = 1.0/convert["INHG"]["PA"];
132 convert["LBS/FT2"]["N/M2"] = 14.5939/convert["FT"]["M"];
133 convert["N/M2"]["LBS/FT2"] = 1.0/convert["LBS/FT2"]["N/M2"];
134 convert["LBS/FT2"]["PA"] = convert["LBS/FT2"]["N/M2"];
135 convert["PA"]["LBS/FT2"] = 1.0/convert["LBS/FT2"]["PA"];
137 convert["KG/MIN"]["LBS/MIN"] = convert["KG"]["LBS"];
139 convert["LBS/HP*HR"]["KG/KW*HR"] = 0.6083;
140 convert["KG/KW*HR"]["LBS/HP*HR"] = 1.0/convert["LBS/HP*HR"]["KG/KW*HR"];
143 convert["M"]["M"] = 1.00;
144 convert["FT"]["FT"] = 1.00;
145 convert["IN"]["IN"] = 1.00;
147 convert["M2"]["M2"] = 1.00;
148 convert["FT2"]["FT2"] = 1.00;
150 convert["IN3"]["IN3"] = 1.00;
151 convert["CC"]["CC"] = 1.0;
152 convert["M3"]["M3"] = 1.0;
153 convert["FT3"]["FT3"] = 1.0;
154 convert["LTR"]["LTR"] = 1.0;
156 convert["KG"]["KG"] = 1.00;
157 convert["LBS"]["LBS"] = 1.00;
158 // Moments of Inertia
159 convert["KG*M2"]["KG*M2"] = 1.00;
160 convert["SLUG*FT2"]["SLUG*FT2"] = 1.00;
162 convert["DEG"]["DEG"] = 1.00;
163 convert["RAD"]["RAD"] = 1.00;
165 convert["LBS/FT"]["LBS/FT"] = 1.00;
166 convert["N/M"]["N/M"] = 1.00;
168 convert["LBS/FT/SEC"]["LBS/FT/SEC"] = 1.00;
169 convert["N/M/SEC"]["N/M/SEC"] = 1.00;
170 // Damping force (Square law)
171 convert["LBS/FT2/SEC2"]["LBS/FT2/SEC2"] = 1.00;
172 convert["N/M2/SEC2"]["N/M2/SEC2"] = 1.00;
174 convert["HP"]["HP"] = 1.00;
175 convert["WATTS"]["WATTS"] = 1.00;
177 convert["N"]["N"] = 1.00;
179 convert["FT/SEC"]["FT/SEC"] = 1.00;
180 convert["KTS"]["KTS"] = 1.00;
181 convert["M/S"]["M/S"] = 1.0;
183 convert["FT*LBS"]["FT*LBS"] = 1.00;
184 convert["N*M"]["N*M"] = 1.00;
186 convert["M4*SEC/KG"]["M4*SEC/KG"] = 1.0;
187 convert["FT4*SEC/SLUG"]["FT4*SEC/SLUG"] = 1.0;
189 convert["PSI"]["PSI"] = 1.00;
190 convert["PSF"]["PSF"] = 1.00;
191 convert["INHG"]["INHG"] = 1.00;
192 convert["ATM"]["ATM"] = 1.0;
193 convert["PA"]["PA"] = 1.0;
194 convert["N/M2"]["N/M2"] = 1.00;
195 convert["LBS/FT2"]["LBS/FT2"] = 1.00;
197 convert["LBS/SEC"]["LBS/SEC"] = 1.00;
198 convert["KG/MIN"]["KG/MIN"] = 1.0;
199 convert["LBS/MIN"]["LBS/MIN"] = 1.0;
201 convert["LBS/HP*HR"]["LBS/HP*HR"] = 1.0;
202 convert["KG/KW*HR"]["KG/KW*HR"] = 1.0;
206 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
208 Element::~Element(void)
210 for (unsigned int i=0; i<children.size(); i++) delete children[i];
213 attribute_key.clear();
216 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
218 string Element::GetAttributeValue(string attr)
221 for (unsigned int i=0; i<attribute_key.size(); i++) {
222 if (attribute_key[i] == attr) select = i;
224 if (select < 0) return string("");
225 else return attributes[attr];
228 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
230 double Element::GetAttributeValueAsNumber(string attr)
232 string attribute = GetAttributeValue(attr);
234 if (attribute.empty()) return HUGE_VAL;
235 else return (atof(attribute.c_str()));
238 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
240 Element* Element::GetElement(unsigned int el)
242 if (children.size() > el) {
252 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
254 Element* Element::GetNextElement(void)
256 if (children.size() > element_index+1) {
258 return children[element_index];
265 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
267 string Element::GetDataLine(unsigned int i)
269 if (data_lines.size() > 0) return data_lines[i];
270 else return string("");
273 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
275 double Element::GetDataAsNumber(void)
277 if (data_lines.size() == 1) {
278 return atof(data_lines[0].c_str());
279 } else if (data_lines.size() == 0) {
282 cerr << "Attempting to get single data value from multiple lines in element " << name << endl;
287 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
289 unsigned int Element::GetNumElements(string element_name)
291 unsigned int number_of_elements=0;
292 Element* el=FindElement(element_name);
294 number_of_elements++;
295 el=FindNextElement(element_name);
297 return number_of_elements;
300 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
302 Element* Element::FindElement(string el)
304 if (el.empty() && children.size() >= 1) {
308 for (unsigned int i=0; i<children.size(); i++) {
309 if (el == children[i]->GetName()) {
318 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
320 Element* Element::FindNextElement(string el)
323 if (element_index < children.size()) {
324 return children[element_index++];
330 for (unsigned int i=element_index; i<children.size(); i++) {
331 if (el == children[i]->GetName()) {
340 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
342 double Element::FindElementValueAsNumber(string el)
344 Element* element = FindElement(el);
346 return element->GetDataAsNumber();
348 cerr << "Attempting to get single data value from multiple lines" << endl;
353 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
355 string Element::FindElementValue(string el)
357 Element* element = FindElement(el);
359 return element->GetDataLine();
365 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
367 double Element::FindElementValueAsNumberConvertTo(string el, string target_units)
369 Element* element = FindElement(el);
372 cerr << "Attempting to get non-existent element " << el << endl;
376 string supplied_units = element->GetAttributeValue("unit");
378 if (!supplied_units.empty()) {
379 if (convert.find(supplied_units) == convert.end()) {
380 cerr << endl << "Supplied unit: \"" << supplied_units << "\" does not exist (typo?). Add new unit"
381 << " conversion in FGXMLElement.cpp." << endl;
384 if (convert[supplied_units].find(target_units) == convert[supplied_units].end()) {
385 cerr << endl << "Supplied unit: \"" << supplied_units << "\" cannot be converted to "
386 << target_units << ". Add new unit conversion in FGXMLElement.cpp or fix typo" << endl;
391 double value = element->GetDataAsNumber();
392 if (!supplied_units.empty()) {
393 value *= convert[supplied_units][target_units];
399 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
401 double Element::FindElementValueAsNumberConvertFromTo( string el,
402 string supplied_units,
405 Element* element = FindElement(el);
408 cerr << "Attempting to get non-existent element " << el << endl;
412 if (!supplied_units.empty()) {
413 if (convert.find(supplied_units) == convert.end()) {
414 cerr << endl << "Supplied unit: \"" << supplied_units << "\" does not exist (typo?). Add new unit"
415 << " conversion in FGXMLElement.cpp." << endl;
418 if (convert[supplied_units].find(target_units) == convert[supplied_units].end()) {
419 cerr << endl << "Supplied unit: \"" << supplied_units << "\" cannot be converted to "
420 << target_units << ". Add new unit conversion in FGXMLElement.cpp or fix typo" << endl;
425 double value = element->GetDataAsNumber();
426 if (!supplied_units.empty()) {
427 value *= convert[supplied_units][target_units];
433 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
435 FGColumnVector3 Element::FindElementTripletConvertTo( string target_units)
437 FGColumnVector3 triplet;
440 string supplied_units = GetAttributeValue("unit");
442 if (!supplied_units.empty()) {
443 if (convert.find(supplied_units) == convert.end()) {
444 cerr << endl << "Supplied unit: \"" << supplied_units << "\" does not exist (typo?). Add new unit"
445 << " conversion in FGXMLElement.cpp." << endl;
448 if (convert[supplied_units].find(target_units) == convert[supplied_units].end()) {
449 cerr << endl << "Supplied unit: \"" << supplied_units << "\" cannot be converted to "
450 << target_units << ". Add new unit conversion in FGXMLElement.cpp or fix typo" << endl;
455 item = FindElement("x");
456 if (!item) item = FindElement("roll");
458 value = item->GetDataAsNumber();
459 if (!supplied_units.empty()) value *= convert[supplied_units][target_units];
462 cerr << "Could not find an X triplet item for this column vector." << endl;
466 item = FindElement("y");
467 if (!item) item = FindElement("pitch");
469 value = item->GetDataAsNumber();
470 if (!supplied_units.empty()) value *= convert[supplied_units][target_units];
473 cerr << "Could not find a Y triplet item for this column vector." << endl;
477 item = FindElement("z");
478 if (!item) item = FindElement("yaw");
480 value = item->GetDataAsNumber();
481 if (!supplied_units.empty()) value *= convert[supplied_units][target_units];
484 cerr << "Could not find a Z triplet item for this column vector." << endl;
491 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
493 void Element::Print(unsigned int level)
495 unsigned int i, spaces;
498 for (spaces=0; spaces<=level; spaces++) cout << " "; // format output
499 cout << "Element Name: " << name;
500 for (i=0; i<attributes.size(); i++) {
501 cout << " " << attribute_key[i] << " = " << attributes[attribute_key[i]];
504 for (i=0; i<data_lines.size(); i++) {
505 for (spaces=0; spaces<=level; spaces++) cout << " "; // format output
506 cout << data_lines[i] << endl;
508 for (i=0; i<children.size(); i++) {
509 children[i]->Print(level);
513 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
515 void Element::AddAttribute(string name, string value)
517 attribute_key.push_back(name);
518 attributes[name] = value;
521 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
523 void Element::AddData(string d)
525 unsigned int string_start = (unsigned int)d.find_first_not_of(" \t");
526 if (string_start > 0) {
527 d.erase(0,string_start);
529 data_lines.push_back(d);
532 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
534 } // end namespace JSBSim