src/FDM/JSBSim/filtersjb/FGGain.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGGain.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 4/2000
   6
   7  ------------- Copyright (C) 2000 -------------
   8
   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
  12  version.
  13
  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
  17  details.
  18
  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.
  22
  23  Further information about the GNU General Public License can also be found on
  24  the world wide web at http://www.gnu.org.
  25
  26 FUNCTIONAL DESCRIPTION
  27 --------------------------------------------------------------------------------
  28
  29 HISTORY
  30 --------------------------------------------------------------------------------
  31
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  33 COMMENTS, REFERENCES,  and NOTES
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35
  36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 INCLUDES
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  39
  40 #include "FGGain.h"
  41
  42 static const char *IdSrc = "$Id$";
  43 static const char *IdHdr = ID_GAIN;
  44
  45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  46 CLASS IMPLEMENTATION
  47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  48
  49
  50 FGGain::FGGain(FGFCS* fcs, FGConfigFile* AC_cfg) : FGFCSComponent(fcs),
  51                                                    AC_cfg(AC_cfg)
  52 {
  53   string token;
  54   string strScheduledBy;
  55
  56   State = fcs->GetState();
  57
  58   Gain = 1.000;
  59   Rows = 0;
  60   Min = Max = 0.0;
  61   OutputPct=0;
  62   invert=false;
  63   ScheduledBy = FG_UNDEF;
  64
  65   Type = AC_cfg->GetValue("TYPE");
  66   Name = AC_cfg->GetValue("NAME");
  67   AC_cfg->GetNextConfigLine();
  68
  69   while ((token = AC_cfg->GetValue()) != string("/COMPONENT")) {
  70     *AC_cfg >> token;
  71     if (token == "ID") {
  72       *AC_cfg >> ID;
  73     } else if (token == "INPUT") {
  74       token = AC_cfg->GetValue("INPUT");
  75       if (token.find("FG_") != token.npos) {
  76         *AC_cfg >> token;
  77         InputIdx = State->GetParameterIndex(token);
  78         InputType = itPilotAC;
  79       } else {
  80         *AC_cfg >> InputIdx;
  81         InputType = itFCS;
  82       }
  83     } else if (token == "GAIN") {
  84       *AC_cfg >> Gain;
  85     } else if (token == "MIN") {
  86       *AC_cfg >> Min;
  87     } else if (token == "MAX") {
  88       *AC_cfg >> Max;
  89     } else if (token == "INVERT") {
  90       invert=true;
  91     } else if (token == "ROWS") {
  92       *AC_cfg >> Rows;
  93       Table = new FGTable(Rows);
  94     } else if (token == "SCHEDULED_BY") {
  95       token = AC_cfg->GetValue("SCHEDULED_BY");
  96       if (token.find("FG_") != token.npos) {
  97         *AC_cfg >> strScheduledBy;
  98         ScheduledBy = State->GetParameterIndex(strScheduledBy);
  99       } else {
 100         *AC_cfg >> ScheduledBy;
 101       }
 102     } else if (token == "OUTPUT") {
 103       IsOutput = true;
 104       *AC_cfg >> sOutputIdx;
 105       OutputIdx = State->GetParameterIndex(sOutputIdx);
 106     } else {
 107       AC_cfg->ResetLineIndexToZero();
 108       *Table << *AC_cfg;
 109     }
 110   }
 111   Debug(0);
 112 }
 113
 114 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 115
 116 FGGain::~FGGain()
 117 {
 118   Debug(1);
 119 }
 120
 121 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 122
 123 bool FGGain::Run(void )
 124 {
 125   double SchedGain = 1.0;
 126   double LookupVal = 0;
 127
 128   FGFCSComponent::Run(); // call the base class for initialization of Input
 129
 130   if (Type == "PURE_GAIN") {
 131     Output = Gain * Input;
 132   } else if (Type == "SCHEDULED_GAIN") {
 133     LookupVal = State->GetParameter(ScheduledBy);
 134           SchedGain = Table->GetValue(LookupVal);
 135     Output = Gain * SchedGain * Input;
 136   } else if (Type == "AEROSURFACE_SCALE") {
 137     if(!invert) {
 138       OutputPct = Input;
 139       if (Input >= 0.0) Output = Input * Max;
 140       else Output = Input * -Min;
 141     } else {
 142       OutputPct=-1*Input;
 143       if (Input <= 0.0) Output = Input * -Max;
 144       else Output = Input * Min;
 145     }
 146     Output *= Gain;
 147   }
 148
 149   if (IsOutput) SetOutput();
 150
 151   return true;
 152 }
 153
 154 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 155 //    The bitmasked value choices are as follows:
 156 //    unset: In this case (the default) JSBSim would only print
 157 //       out the normally expected messages, essentially echoing
 158 //       the config files as they are read. If the environment
 159 //       variable is not set, debug_lvl is set to 1 internally
 160 //    0: This requests JSBSim not to output any messages
 161 //       whatsoever.
 162 //    1: This value explicity requests the normal JSBSim
 163 //       startup messages
 164 //    2: This value asks for a message to be printed out when
 165 //       a class is instantiated
 166 //    4: When this value is set, a message is displayed when a
 167 //       FGModel object executes its Run() method
 168 //    8: When this value is set, various runtime state variables
 169 //       are printed out periodically
 170 //    16: When set various parameters are sanity checked and
 171 //       a message is printed out when they go out of bounds
 172
 173 void FGGain::Debug(int from)
 174 {
 175   if (debug_lvl <= 0) return;
 176
 177   if (debug_lvl & 1) { // Standard console startup message output
 178     if (from == 0) { // Constructor
 179       cout << "      ID: " << ID << endl;
 180       switch(InputType) {
 181       case itPilotAC:
 182         cout << "      INPUT: " << State->GetParameterName(InputIdx) << endl;
 183         break;
 184       case itFCS:
 185         cout << "      INPUT: FCS Component " << InputIdx << " (" <<
 186                                         fcs->GetComponentName(InputIdx) << ")" << endl;
 187         break;
 188       }
 189       cout << "      GAIN: " << Gain << endl;
 190       if (IsOutput) cout << "      OUTPUT: " << sOutputIdx << endl;
 191       cout << "      MIN: " << Min << endl;
 192       cout << "      MAX: " << Max << endl;
 193       if(invert) cout << "      Invert mapping" << endl;
 194       if (ScheduledBy != FG_UNDEF) {
 195         cout << "      Scheduled by parameter: " << ScheduledBy << endl;
 196         Table->Print();
 197       }
 198     }
 199   }
 200   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 201     if (from == 0) cout << "Instantiated: FGGain" << endl;
 202     if (from == 1) cout << "Destroyed:    FGGain" << endl;
 203   }
 204   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 205   }
 206   if (debug_lvl & 8 ) { // Runtime state variables
 207   }
 208   if (debug_lvl & 16) { // Sanity checking
 209   }
 210   if (debug_lvl & 64) {
 211     if (from == 0) { // Constructor
 212       cout << IdSrc << endl;
 213       cout << IdHdr << endl;
 214     }
 215   }
 216 }
 217