1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7 ------------- Copyright (C) 2000 -------------
9 This program is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free Software
11 Foundation; either version 2 of the License, or (at your option) any later
14 This program is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 You should have received a copy of the GNU General Public License along with
20 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
21 Place - Suite 330, Boston, MA 02111-1307, USA.
23 Further information about the GNU General Public License can also be found on
24 the world wide web at http://www.gnu.org.
26 FUNCTIONAL DESCRIPTION
27 --------------------------------------------------------------------------------
30 --------------------------------------------------------------------------------
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33 COMMENTS, REFERENCES, and NOTES
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
44 static const char *IdSrc = "$Id$";
45 static const char *IdHdr = ID_GAIN;
47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
52 FGGain::FGGain(FGFCS* fcs, FGConfigFile* AC_cfg) : FGFCSComponent(fcs),
56 string strScheduledBy;
59 State = fcs->GetState();
68 clipmin = clipmax = 0.0;
70 Type = AC_cfg->GetValue("TYPE");
71 Name = AC_cfg->GetValue("NAME");
72 AC_cfg->GetNextConfigLine();
74 while ((token = AC_cfg->GetValue()) != string("/COMPONENT")) {
76 if (token == "INPUT") {
79 if (token[0] == '-') {
84 if (InputNodes.size() > 0) {
85 cerr << "Gains can only accept one input" << endl;
87 InputNodes.push_back( resolveSymbol(token) );
90 } else if (token == "GAIN") {
92 } else if (token == "MIN") {
94 } else if (token == "MAX") {
96 } else if (token == "CLIPTO") {
97 *AC_cfg >> clipmin >> clipmax;
98 if (clipmax > clipmin) {
101 } else if (token == "INVERT") {
103 cerr << endl << "The INVERT keyword is being deprecated and will not be "
104 "supported in the future. Please use a minus sign in front "
105 "of an input property in the future." << endl << endl;
106 } else if (token == "ROWS") {
108 Table = new FGTable(Rows);
109 } else if (token == "SCHEDULED_BY") {
110 token = AC_cfg->GetValue("SCHEDULED_BY");
111 *AC_cfg >> strScheduledBy;
112 ScheduledBy = PropertyManager->GetNode( strScheduledBy );
113 } else if (token == "OUTPUT") {
115 *AC_cfg >> sOutputIdx;
116 OutputNode = PropertyManager->GetNode( sOutputIdx, true );
118 AC_cfg->ResetLineIndexToZero();
123 FGFCSComponent::bind();
124 if (Type == "AEROSURFACE_SCALE")
125 treenode->Tie( "output-norm", this, &FGGain::GetOutputPct );
130 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
137 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
139 bool FGGain::Run(void )
141 double SchedGain = 1.0;
142 double LookupVal = 0;
144 FGFCSComponent::Run(); // call the base class for initialization of Input
145 Input = InputNodes[0]->getDoubleValue();
147 if (invert) Input = -Input;
149 if (Type == "PURE_GAIN") { // PURE_GAIN
151 Output = Gain * Input;
153 } else if (Type == "SCHEDULED_GAIN") { // SCHEDULED_GAIN
155 LookupVal = ScheduledBy->getDoubleValue();
156 SchedGain = Table->GetValue(LookupVal);
157 Output = Gain * SchedGain * Input;
159 } else if (Type == "AEROSURFACE_SCALE") { // AEROSURFACE_SCALE
162 if (Input >= 0.0) Output = Input * Max;
163 else Output = Input * -Min;
169 if (Output > clipmax) Output = clipmax;
170 else if (Output < clipmin) Output = clipmin;
173 if (IsOutput) SetOutput();
178 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
180 void FGGain::convert(void)
183 cout << " <component name=\"" << Name << "\" type=\"" << Type << "\">" << endl;
186 cout << " <input>-" << (InputNodes[0]->GetFullyQualifiedName()).substr(12) << "</input>" << endl;
188 cout << " <input>" << (InputNodes[0]->GetFullyQualifiedName()).substr(12) << "</input>" << endl;
191 cout << " <gain>" << Gain << "</gain>" << endl;
193 if (Type == "PURE_GAIN") { // PURE_GAIN
194 } else if (Type == "SCHEDULED_GAIN") { // SCHEDULED_GAIN
195 cout << " <table>" << endl;
196 cout << " <independentVar>" << ScheduledBy->GetFullyQualifiedName().substr(12) << "</independentVar>" << endl;
197 cout << " <tableData>" << endl;
199 cout << " </tableData>" << endl;
200 cout << " </table>" << endl;
201 } else if (Type == "AEROSURFACE_SCALE") { // AEROSURFACE_SCALE
202 cout << " <limit>" << endl;
203 cout << " <min>" << Min << "</min>" << endl;
204 cout << " <max>" << Max << "</max>" << endl;
205 cout << " </limit>" << endl;
209 cout << " <clip>" << endl;
210 cout << " <min>" << clipmin << "</min>" << endl;
211 cout << " <max>" << clipmax << "</max>" << endl;
212 cout << " </clip>" << endl;
216 cout << " <output>" << (OutputNode->GetFullyQualifiedName()).substr(12) << "</output>" << endl;
218 cout << " </component>" << endl;
221 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
222 // The bitmasked value choices are as follows:
223 // unset: In this case (the default) JSBSim would only print
224 // out the normally expected messages, essentially echoing
225 // the config files as they are read. If the environment
226 // variable is not set, debug_lvl is set to 1 internally
227 // 0: This requests JSBSim not to output any messages
229 // 1: This value explicity requests the normal JSBSim
231 // 2: This value asks for a message to be printed out when
232 // a class is instantiated
233 // 4: When this value is set, a message is displayed when a
234 // FGModel object executes its Run() method
235 // 8: When this value is set, various runtime state variables
236 // are printed out periodically
237 // 16: When set various parameters are sanity checked and
238 // a message is printed out when they go out of bounds
240 void FGGain::Debug(int from)
242 if (debug_lvl <= 0) return;
244 if (debug_lvl & 1) { // Standard console startup message output
245 if (from == 0) { // Constructor
247 cout << " INPUT: -" << InputNodes[0]->getName() << endl;
249 cout << " INPUT: " << InputNodes[0]->getName() << endl;
251 cout << " GAIN: " << Gain << endl;
252 if (IsOutput) cout << " OUTPUT: " << OutputNode->getName() << endl;
253 cout << " MIN: " << Min << endl;
254 cout << " MAX: " << Max << endl;
255 if (ScheduledBy != 0) {
256 cout << " Scheduled by parameter: " << ScheduledBy->getName() << endl;
261 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
262 if (from == 0) cout << "Instantiated: FGGain" << endl;
263 if (from == 1) cout << "Destroyed: FGGain" << endl;
265 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
267 if (debug_lvl & 8 ) { // Runtime state variables
269 if (debug_lvl & 16) { // Sanity checking
271 if (debug_lvl & 64) {
272 if (from == 0) { // Constructor
273 cout << IdSrc << endl;
274 cout << IdHdr << endl;