1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 Purpose: Models a lookup table
8 ------------- Copyright (C) 2001 Jon S. Berndt (jsb@hal-pc.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 FUNCTIONAL DESCRIPTION
28 --------------------------------------------------------------------------------
32 --------------------------------------------------------------------------------
35 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
41 #if defined ( sgi ) && !defined( __GNUC__ ) && (_COMPILER_VERSION < 740)
51 static const char *IdSrc = "$Id$";
52 static const char *IdHdr = ID_TABLE;
54 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
58 FGTable::FGTable(int NRows) : nRows(NRows), nCols(1), PropertyManager(0)
67 lastRowIndex=lastColumnIndex=2;
70 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
72 FGTable::FGTable(const FGTable& t) : PropertyManager(t.PropertyManager)
75 colCounter = t.colCounter;
76 rowCounter = t.rowCounter;
77 tableCounter = t.tableCounter;
81 dimension = t.dimension;
82 internal = t.internal;
84 lookupProperty[0] = t.lookupProperty[0];
85 lookupProperty[1] = t.lookupProperty[1];
86 lookupProperty[2] = t.lookupProperty[2];
90 for (unsigned int r=0; r<=nRows; r++) {
91 for (unsigned int c=0; c<=nCols; c++) {
92 Data[r][c] = t.Data[r][c];
95 lastRowIndex = t.lastRowIndex;
96 lastColumnIndex = t.lastColumnIndex;
97 lastTableIndex = t.lastTableIndex;
100 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
102 FGTable::FGTable(FGPropertyManager* propMan, Element* el) : PropertyManager(propMan)
107 string property_string;
112 FGPropertyManager* node;
113 Element *tableData=0;
114 Element *parent_element=0;
115 Element *axisElement=0;
116 string operation_types = "function, product, sum, difference, quotient,"
117 "pow, abs, sin, cos, asin, acos, tan, atan, table";
121 // Is this an internal lookup table?
124 Name = el->GetAttributeValue("name"); // Allow this table to be named with a property
125 call_type = el->GetAttributeValue("type");
126 if (call_type == string("internal")) {
127 parent_element = el->GetParent();
128 parent_type = parent_element->GetName();
129 if (operation_types.find(parent_type) == string::npos) {
132 // internal table is a child element of a restricted type
133 cerr << endl << fgred << " An internal table cannot be nested within another type," << endl;
134 cerr << " such as a function. The 'internal' keyword is ignored." << fgdef << endl << endl;
136 } else if (!call_type.empty()) {
137 cerr << endl << fgred << " An unknown table type attribute is listed: " << call_type
138 << ". Execution cannot continue." << fgdef << endl << endl;
142 // Determine and store the lookup properties for this table unless this table
143 // is part of a 3D table, in which case its independentVar property indexes will
144 // be set by a call from the owning table during creation
148 axisElement = el->FindElement("independentVar");
151 // The 'internal' attribute of the table element cannot be specified
152 // at the same time that independentVars are specified.
154 cerr << endl << fgred << " This table specifies both 'internal' call type" << endl;
155 cerr << " and specific lookup properties via the 'independentVar' element." << endl;
156 cerr << " These are mutually exclusive specifications. The 'internal'" << endl;
157 cerr << " attribute will be ignored." << fgdef << endl << endl;
161 for (i=0; i<3; i++) lookupProperty[i] = 0;
163 while (axisElement) {
164 property_string = axisElement->GetDataLine();
165 // The property string passed into GetNode() must have no spaces or tabs.
166 node = PropertyManager->GetNode(property_string);
169 cerr << "IndependenVar property, " << property_string
170 << " in Table definition is not defined." << endl;
174 lookup_axis = axisElement->GetAttributeValue("lookup");
175 if (lookup_axis == string("row")) {
176 lookupProperty[eRow] = node;
177 } else if (lookup_axis == string("column")) {
178 lookupProperty[eColumn] = node;
179 } else if (lookup_axis == string("table")) {
180 lookupProperty[eTable] = node;
181 } else { // assumed single dimension table; row lookup
182 lookupProperty[eRow] = node;
185 axisElement = el->FindNextElement("independentVar");
188 } else if (internal) { // This table is an internal table
190 // determine how many rows, columns, and tables in this table (dimension).
192 if (el->GetNumElements("tableData") > 1) {
193 dimension = 3; // this is a 3D table
195 tableData = el->FindElement("tableData");
196 string test_line = tableData->GetDataLine(1); // examine second line in table for dimension
197 if (FindNumColumns(test_line) == 2) dimension = 1; // 1D table
198 else if (FindNumColumns(test_line) > 2) dimension = 2; // 2D table
200 cerr << "Invalid number of columns in table" << endl;
205 brkpt_string = el->GetAttributeValue("breakPoint");
206 if (brkpt_string.empty()) {
207 // no independentVars found, and table is not marked as internal, nor is it a 3D table
208 cerr << endl << fgred << "No independent variable found for table." << fgdef << endl << endl;
212 // end lookup property code
214 if (brkpt_string.empty()) { // Not a 3D table "table element"
215 tableData = el->FindElement("tableData");
216 } else { // This is a table in a 3D table
218 dimension = 2; // Currently, infers 2D table
221 for (i=0; i<tableData->GetNumDataLines(); i++) {
222 buf << tableData->GetDataLine(i) << string(" ");
226 nRows = tableData->GetNumDataLines();
233 lastRowIndex = lastColumnIndex = 2;
237 nRows = tableData->GetNumDataLines()-1;
239 if (nRows >= 2) nCols = FindNumColumns(tableData->GetDataLine(0));
241 cerr << endl << fgred << "Not enough rows in this table." << fgdef << endl;
250 lastRowIndex = lastColumnIndex = 2;
254 nTables = el->GetNumElements("tableData");
260 lastRowIndex = lastColumnIndex = 2;
262 Data = Allocate(); // this data array will contain the keys for the associated tables
263 Tables.reserve(nTables); // necessary?
264 tableData = el->FindElement("tableData");
265 for (i=0; i<nTables; i++) {
266 Tables.push_back(new FGTable(PropertyManager, tableData));
267 Data[i+1][1] = tableData->GetAttributeValueAsNumber("breakPoint");
268 Tables[i]->SetRowIndexProperty(lookupProperty[eRow]);
269 Tables[i]->SetColumnIndexProperty(lookupProperty[eColumn]);
270 tableData = el->FindNextElement("tableData");
276 cout << "No dimension given" << endl;
282 if (debug_lvl & 1) Print();
285 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
287 double** FGTable::Allocate(void)
289 Data = new double*[nRows+1];
290 for (unsigned int r=0; r<=nRows; r++) {
291 Data[r] = new double[nCols+1];
292 for (unsigned int c=0; c<=nCols; c++) {
299 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
303 if (!Name.empty() && !internal) {
304 string tmp = PropertyManager->mkPropertyName(Name, false); // Allow upper case
305 PropertyManager->Untie(tmp);
309 for (unsigned int i=0; i<nTables; i++) delete Tables[i];
312 for (unsigned int r=0; r<=nRows; r++) delete[] Data[r];
318 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
320 unsigned int FGTable::FindNumColumns(string test_line)
322 // determine number of data columns in table (first column is row lookup - don't count)
324 unsigned int nCols=0;
325 while ((position = test_line.find_first_not_of(" \t", position)) != string::npos) {
327 position = test_line.find_first_of(" \t", position);
332 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
334 double FGTable::GetValue(void) const
341 temp = lookupProperty[eRow]->getDoubleValue();
342 temp2 = GetValue(temp);
345 return GetValue(lookupProperty[eRow]->getDoubleValue(),
346 lookupProperty[eColumn]->getDoubleValue());
348 return GetValue(lookupProperty[eRow]->getDoubleValue(),
349 lookupProperty[eColumn]->getDoubleValue(),
350 lookupProperty[eTable]->getDoubleValue());
352 cerr << "Attempted to GetValue() for invalid/unknown table type" << endl;
353 throw(string("Attempted to GetValue() for invalid/unknown table type"));
357 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
359 double FGTable::GetValue(double key) const
361 double Factor, Value, Span;
362 unsigned int r = lastRowIndex;
364 //if the key is off the end of the table, just return the
365 //end-of-table value, do not extrapolate
366 if( key <= Data[1][0] ) {
368 //cout << "Key underneath table: " << key << endl;
370 } else if ( key >= Data[nRows][0] ) {
372 //cout << "Key over table: " << key << endl;
373 return Data[nRows][1];
376 // the key is somewhere in the middle, search for the right breakpoint
377 // The search is particularly efficient if
378 // the correct breakpoint has not changed since last frame or
379 // has only changed very little
381 while (r > 2 && Data[r-1][0] > key) { r--; }
382 while (r < nRows && Data[r][0] < key) { r++; }
385 // make sure denominator below does not go to zero.
387 Span = Data[r][0] - Data[r-1][0];
389 Factor = (key - Data[r-1][0]) / Span;
390 if (Factor > 1.0) Factor = 1.0;
395 Value = Factor*(Data[r][1] - Data[r-1][1]) + Data[r-1][1];
400 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
402 double FGTable::GetValue(double rowKey, double colKey) const
404 double rFactor, cFactor, col1temp, col2temp, Value;
405 unsigned int r = lastRowIndex;
406 unsigned int c = lastColumnIndex;
408 while(r > 2 && Data[r-1][0] > rowKey) { r--; }
409 while(r < nRows && Data[r] [0] < rowKey) { r++; }
411 while(c > 2 && Data[0][c-1] > colKey) { c--; }
412 while(c < nCols && Data[0][c] < colKey) { c++; }
417 rFactor = (rowKey - Data[r-1][0]) / (Data[r][0] - Data[r-1][0]);
418 cFactor = (colKey - Data[0][c-1]) / (Data[0][c] - Data[0][c-1]);
420 if (rFactor > 1.0) rFactor = 1.0;
421 else if (rFactor < 0.0) rFactor = 0.0;
423 if (cFactor > 1.0) cFactor = 1.0;
424 else if (cFactor < 0.0) cFactor = 0.0;
426 col1temp = rFactor*(Data[r][c-1] - Data[r-1][c-1]) + Data[r-1][c-1];
427 col2temp = rFactor*(Data[r][c] - Data[r-1][c]) + Data[r-1][c];
429 Value = col1temp + cFactor*(col2temp - col1temp);
434 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
436 double FGTable::GetValue(double rowKey, double colKey, double tableKey) const
438 double Factor, Value, Span;
439 unsigned int r = lastRowIndex;
441 //if the key is off the end (or before the beginning) of the table,
442 // just return the boundary-table value, do not extrapolate
444 if( tableKey <= Data[1][1] ) {
446 return Tables[0]->GetValue(rowKey, colKey);
447 } else if ( tableKey >= Data[nRows][1] ) {
449 return Tables[nRows-1]->GetValue(rowKey, colKey);
452 // the key is somewhere in the middle, search for the right breakpoint
453 // The search is particularly efficient if
454 // the correct breakpoint has not changed since last frame or
455 // has only changed very little
457 while(r > 2 && Data[r-1][1] > tableKey) { r--; }
458 while(r < nRows && Data[r] [1] < tableKey) { r++; }
461 // make sure denominator below does not go to zero.
463 Span = Data[r][1] - Data[r-1][1];
465 Factor = (tableKey - Data[r-1][1]) / Span;
466 if (Factor > 1.0) Factor = 1.0;
471 Value = Factor*(Tables[r-1]->GetValue(rowKey, colKey) - Tables[r-2]->GetValue(rowKey, colKey))
472 + Tables[r-2]->GetValue(rowKey, colKey);
477 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
479 void FGTable::operator<<(stringstream& in_stream)
484 // In 1D table, no pseudo-row of column-headers (i.e. keys):
485 if (Type == tt1D) startRow = 1;
487 for (unsigned int r=startRow; r<=nRows; r++) {
488 for (unsigned int c=startCol; c<=nCols; c++) {
489 if (r != 0 || c != 0) {
490 in_stream >> Data[r][c];
496 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
498 FGTable& FGTable::operator<<(const double n)
500 Data[rowCounter][colCounter] = n;
501 if (colCounter == nCols) {
510 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
512 FGTable& FGTable::operator<<(const int n)
518 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
520 void FGTable::Print(void)
525 if (Type == tt1D || Type == tt3D) startRow = 1;
526 if (Type == tt3D) startCol = 1;
528 #if defined (sgi) && !defined(__GNUC__) && (_COMPILER_VERSION < 740)
529 unsigned long flags = cout.setf(ios::fixed);
531 ios::fmtflags flags = cout.setf(ios::fixed); // set up output stream
536 cout << " 1 dimensional table with " << nRows << " rows." << endl;
539 cout << " 2 dimensional table with " << nRows << " rows, " << nCols << " columns." << endl;
542 cout << " 3 dimensional table with " << nRows << " rows, "
543 << nCols << " columns "
544 << nTables << " tables." << endl;
548 for (unsigned int r=startRow; r<=nRows; r++) {
550 for (unsigned int c=startCol; c<=nCols; c++) {
551 if (r == 0 && c == 0) {
554 cout << Data[r][c] << " ";
557 Tables[r-1]->Print();
563 cout.setf(flags); // reset
566 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
568 void FGTable::bind(void)
570 typedef double (FGTable::*PMF)(void) const;
571 if ( !Name.empty() && !internal) {
572 string tmp = PropertyManager->mkPropertyName(Name, false); // Allow upper
573 PropertyManager->Tie( tmp, this, (PMF)&FGTable::GetValue);
576 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
577 // The bitmasked value choices are as follows:
578 // unset: In this case (the default) JSBSim would only print
579 // out the normally expected messages, essentially echoing
580 // the config files as they are read. If the environment
581 // variable is not set, debug_lvl is set to 1 internally
582 // 0: This requests JSBSim not to output any messages
584 // 1: This value explicity requests the normal JSBSim
586 // 2: This value asks for a message to be printed out when
587 // a class is instantiated
588 // 4: When this value is set, a message is displayed when a
589 // FGModel object executes its Run() method
590 // 8: When this value is set, various runtime state variables
591 // are printed out periodically
592 // 16: When set various parameters are sanity checked and
593 // a message is printed out when they go out of bounds
595 void FGTable::Debug(int from)
597 if (debug_lvl <= 0) return;
599 if (debug_lvl & 1) { // Standard console startup message output
600 if (from == 0) { // Constructor
604 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
605 if (from == 0) cout << "Instantiated: FGTable" << endl;
606 if (from == 1) cout << "Destroyed: FGTable" << endl;
608 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
610 if (debug_lvl & 8 ) { // Runtime state variables
612 if (debug_lvl & 16) { // Sanity checking
614 if (debug_lvl & 64) {
615 if (from == 0) { // Constructor
616 cout << IdSrc << endl;
617 cout << IdHdr << endl;