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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
42 static const char *IdSrc = "$Id$";
43 static const char *IdHdr = ID_GAIN;
45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
50 FGGain::FGGain(FGFCS* fcs, FGConfigFile* AC_cfg) : FGFCSComponent(fcs),
54 string strScheduledBy;
56 State = fcs->GetState();
61 ScheduledBy = FG_UNDEF;
63 Type = AC_cfg->GetValue("TYPE");
64 Name = AC_cfg->GetValue("NAME");
65 AC_cfg->GetNextConfigLine();
67 while ((token = AC_cfg->GetValue()) != string("/COMPONENT")) {
71 } else if (token == "INPUT") {
72 token = AC_cfg->GetValue("INPUT");
73 if (token.find("FG_") != token.npos) {
75 InputIdx = State->GetParameterIndex(token);
76 InputType = itPilotAC;
81 } else if (token == "GAIN") {
83 } else if (token == "MIN") {
85 } else if (token == "MAX") {
87 } else if (token == "ROWS") {
89 Table = new FGTable(Rows);
90 } else if (token == "SCHEDULED_BY") {
91 token = AC_cfg->GetValue("SCHEDULED_BY");
92 if (token.find("FG_") != token.npos) {
93 *AC_cfg >> strScheduledBy;
94 ScheduledBy = State->GetParameterIndex(strScheduledBy);
96 *AC_cfg >> ScheduledBy;
98 } else if (token == "OUTPUT") {
100 *AC_cfg >> sOutputIdx;
101 OutputIdx = State->GetParameterIndex(sOutputIdx);
103 AC_cfg->ResetLineIndexToZero();
110 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
117 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
119 bool FGGain::Run(void )
121 double SchedGain = 1.0;
122 double LookupVal = 0;
124 FGFCSComponent::Run(); // call the base class for initialization of Input
126 if (Type == "PURE_GAIN") {
127 Output = Gain * Input;
128 } else if (Type == "SCHEDULED_GAIN") {
129 LookupVal = State->GetParameter(ScheduledBy);
130 SchedGain = Table->GetValue(LookupVal);
131 Output = Gain * SchedGain * Input;
132 } else if (Type == "AEROSURFACE_SCALE") {
133 if (Output >= 0.0) Output = Input * Max;
134 else Output = Input * (-Min);
138 if (IsOutput) SetOutput();
143 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
144 // The bitmasked value choices are as follows:
145 // unset: In this case (the default) JSBSim would only print
146 // out the normally expected messages, essentially echoing
147 // the config files as they are read. If the environment
148 // variable is not set, debug_lvl is set to 1 internally
149 // 0: This requests JSBSim not to output any messages
151 // 1: This value explicity requests the normal JSBSim
153 // 2: This value asks for a message to be printed out when
154 // a class is instantiated
155 // 4: When this value is set, a message is displayed when a
156 // FGModel object executes its Run() method
157 // 8: When this value is set, various runtime state variables
158 // are printed out periodically
159 // 16: When set various parameters are sanity checked and
160 // a message is printed out when they go out of bounds
162 void FGGain::Debug(int from)
164 if (debug_lvl <= 0) return;
166 if (debug_lvl & 1) { // Standard console startup message output
167 if (from == 0) { // Constructor
168 cout << " ID: " << ID << endl;
171 cout << " INPUT: " << State->GetParameterName(InputIdx) << endl;
174 cout << " INPUT: FCS Component " << InputIdx << " (" <<
175 fcs->GetComponentName(InputIdx) << ")" << endl;
178 cout << " GAIN: " << Gain << endl;
179 if (IsOutput) cout << " OUTPUT: " << sOutputIdx << endl;
180 cout << " MIN: " << Min << endl;
181 cout << " MAX: " << Max << endl;
182 if (ScheduledBy != FG_UNDEF) {
183 cout << " Scheduled by parameter: " << ScheduledBy << endl;
188 if (debug_lvl & 2 ) { // Instantiation/Destruction notification
189 if (from == 0) cout << "Instantiated: FGGain" << endl;
190 if (from == 1) cout << "Destroyed: FGGain" << endl;
192 if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
194 if (debug_lvl & 8 ) { // Runtime state variables
196 if (debug_lvl & 16) { // Sanity checking
198 if (debug_lvl & 64) {
199 if (from == 0) { // Constructor
200 cout << IdSrc << endl;
201 cout << IdHdr << endl;