1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 Module: FGFactorGroup.cpp
6 Purpose: Encapsulates coefficients in the mathematical construct:
7 factor*(coeff1 + coeff2 + coeff3 + ... + coeffn)
8 Called by: FGAerodynamics
10 ------------- Copyright (C) 2001 Tony Peden (apeden@earthlink.net) -----------
12 This program is free software; you can redistribute it and/or modify it under
13 the terms of the GNU General Public License as published by the Free Software
14 Foundation; either version 2 of the License, or (at your option) any later
17 This program is distributed in the hope that it will be useful, but WITHOUT
18 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22 You should have received a copy of the GNU General Public License along with
23 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
24 Place - Suite 330, Boston, MA 02111-1307, USA.
26 Further information about the GNU General Public License can also be found on
27 the world wide web at http://www.gnu.org.
29 FUNCTIONAL DESCRIPTION
30 --------------------------------------------------------------------------------
31 This class models the stability derivative coefficient lookup tables or
32 equations. Note that the coefficients need not be calculated each delta-t.
34 Note that the values in a row which index into the table must be the same value
35 for each column of data, so the first column of numbers for each altitude are
36 seen to be equal, and there are the same number of values for each altitude.
38 See the header file FGFactorGroup.h for the values of the identifiers.
41 --------------------------------------------------------------------------------
44 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
46 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
48 #include "FGCoefficient.h"
49 #include "FGFactorGroup.h"
51 #include "FGFDMExec.h"
54 # if defined(sgi) && !defined(__GNUC__)
63 static const char *IdSrc = "$Id$";
64 static const char *IdHdr = ID_FACTORGROUP;
66 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
68 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
70 FGFactorGroup::FGFactorGroup( FGFDMExec* fdmex ) : FGCoefficient( fdmex)
77 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
79 FGFactorGroup::~FGFactorGroup()
81 for (unsigned int i=0; i<sum.size(); i++) delete sum[i];
86 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
88 bool FGFactorGroup::Load(FGConfigFile *AC_cfg)
93 name = AC_cfg->GetValue("NAME");
94 AC_cfg->GetNextConfigLine();
95 *AC_cfg >> description;
96 token = AC_cfg->GetValue();
97 if (token == "FACTOR") {
98 FGCoefficient::Load(AC_cfg);
100 token = AC_cfg->GetValue();
101 while (token != string("/GROUP") ) {
102 sum.push_back( new FGCoefficient(FDMExec) );
103 sum.back()->Load(AC_cfg);
104 token = AC_cfg->GetValue();
106 AC_cfg->GetNextConfigLine();
113 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
115 double FGFactorGroup::TotalValue(void)
120 for (i=0; i<sum.size(); i++) {
121 totalValue += sum[i]->TotalValue();
122 SDtotal += sum[i]->GetSD();
124 totalValue *= FGCoefficient::TotalValue();
125 SDtotal *= FGCoefficient::GetSD();
130 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
132 void FGFactorGroup::bind(FGPropertyManager* parent)
135 node=parent->GetNode(name,true);
136 node->SetString("description",description);
137 FGCoefficient::bind(node);
138 for (i=0; i < sum.size(); i++) {
141 node=(FGPropertyManager*)node->getParent();
145 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
147 void FGFactorGroup::unbind(void)
151 FGCoefficient::unbind();
152 for (i=0; i < sum.size(); i++) {
157 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
158 // The bitmasked value choices are as follows:
159 // unset: In this case (the default) JSBSim would only print
160 // out the normally expected messages, essentially echoing
161 // the config files as they are read. If the environment
162 // variable is not set, debug_lvl is set to 1 internally
163 // 0: This requests JSBSim not to output any messages
165 // 1: This value explicity requests the normal JSBSim
167 // 2: This value asks for a message to be printed out when
168 // a class is instantiated
169 // 4: When this value is set, a message is displayed when a
170 // FGModel object executes its Run() method
171 // 8: When this value is set, various runtime state variables
172 // are printed out periodically
173 // 16: When set various parameters are sanity checked and
174 // a message is printed out when they go out of bounds
176 void FGFactorGroup::Debug(int from)
178 if (debug_lvl <= 0) return;
180 if (debug_lvl & 1) { // Standard console startup message output
182 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
183 if (from == 0) cout << "Instantiated: FGFactorGroup" << endl;
184 if (from == 1) cout << "Destroyed: FGFactorGroup" << endl;
186 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
188 if (debug_lvl & 8 ) { // Runtime state variables
190 cout << "FGCoefficient::GetSD(): " << FGCoefficient::GetSD() << endl;
191 cout << "FGFactorGroup::SDtotal: " << SDtotal << endl;
194 if (debug_lvl & 16) { // Sanity checking
196 if (debug_lvl & 64) {
197 if (from == 0) { // Constructor
198 cout << IdSrc << endl;
199 cout << IdHdr << endl;