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   string sOutputIdx;
  56
  57   State = fcs->GetState();
  58
  59   Gain = 1.000;
  60   Rows = 0;
  61   Min = Max = 0.0;
  62   OutputPct=0;
  63   invert=false;
  64   ScheduledBy = 0;
  65
  66   Type = AC_cfg->GetValue("TYPE");
  67   Name = AC_cfg->GetValue("NAME");
  68   AC_cfg->GetNextConfigLine();
  69
  70   while ((token = AC_cfg->GetValue()) != string("/COMPONENT")) {
  71     *AC_cfg >> token;
  72     if (token == "ID") {
  73       *AC_cfg >> ID;
  74     } else if (token == "INPUT") {
  75       token = AC_cfg->GetValue("INPUT");
  76       if (token.find("FG_") != token.npos) {
  77         *AC_cfg >> token;
  78         InputNode = PropertyManager->GetNode(
  79                     fcs->GetState()->GetPropertyName(token) );
  80         InputType = itPilotAC;
  81       } else {
  82         *AC_cfg >> InputIdx;
  83         InputType = itFCS;
  84       }
  85     } else if (token == "GAIN") {
  86       *AC_cfg >> Gain;
  87     } else if (token == "MIN") {
  88       *AC_cfg >> Min;
  89     } else if (token == "MAX") {
  90       *AC_cfg >> Max;
  91     } else if (token == "INVERT") {
  92       invert=true;
  93     } else if (token == "ROWS") {
  94       *AC_cfg >> Rows;
  95       Table = new FGTable(Rows);
  96     } else if (token == "SCHEDULED_BY") {
  97       token = AC_cfg->GetValue("SCHEDULED_BY");
  98       if (token.find("FG_") != token.npos) {
  99         *AC_cfg >> strScheduledBy;
 100         ScheduledBy = PropertyManager->GetNode(
 101                        fcs->GetState()->GetPropertyName(strScheduledBy) );
 102       }
 103     } else if (token == "OUTPUT") {
 104       IsOutput = true;
 105       *AC_cfg >> sOutputIdx;
 106       OutputNode = PropertyManager->GetNode(
 107                      fcs->GetState()->GetPropertyName(sOutputIdx) );
 108
 109     } else {
 110       AC_cfg->ResetLineIndexToZero();
 111       *Table << *AC_cfg;
 112     }
 113   }
 114   Debug(0);
 115 }
 116
 117 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 118
 119 FGGain::~FGGain()
 120 {
 121   Debug(1);
 122 }
 123
 124 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 125
 126 bool FGGain::Run(void )
 127 {
 128   double SchedGain = 1.0;
 129   double LookupVal = 0;
 130
 131   FGFCSComponent::Run(); // call the base class for initialization of Input
 132
 133   if (Type == "PURE_GAIN") {
 134     Output = Gain * Input;
 135   } else if (Type == "SCHEDULED_GAIN") {
 136     LookupVal = ScheduledBy->getDoubleValue();
 137           SchedGain = Table->GetValue(LookupVal);
 138     Output = Gain * SchedGain * Input;
 139   } else if (Type == "AEROSURFACE_SCALE") {
 140     if(!invert) {
 141       OutputPct = Input;
 142       if (Input >= 0.0) Output = Input * Max;
 143       else Output = Input * -Min;
 144     } else {
 145       OutputPct=-1*Input;
 146       if (Input <= 0.0) Output = Input * -Max;
 147       else Output = Input * Min;
 148     }
 149     Output *= Gain;
 150   }
 151
 152   if (IsOutput) SetOutput();
 153
 154   return true;
 155 }
 156
 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
 164 //       whatsoever.
 165 //    1: This value explicity requests the normal JSBSim
 166 //       startup messages
 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
 175
 176 void FGGain::Debug(int from)
 177 {
 178   if (debug_lvl <= 0) return;
 179
 180   if (debug_lvl & 1) { // Standard console startup message output
 181     if (from == 0) { // Constructor
 182       cout << "      ID: " << ID << endl;
 183       switch(InputType) {
 184       case itPilotAC:
 185         cout << "      INPUT: " << InputNode->getName() << endl;
 186         break;
 187       case itFCS:
 188         cout << "      INPUT: FCS Component " << InputIdx << " (" <<
 189                                         fcs->GetComponentName(InputIdx) << ")" << endl;
 190         break;
 191       case itAP:
 192       case itBias:
 193         break;
 194       }
 195       cout << "      GAIN: " << Gain << endl;
 196       if (IsOutput) cout << "      OUTPUT: " << OutputNode->getName() << endl;
 197       cout << "      MIN: " << Min << endl;
 198       cout << "      MAX: " << Max << endl;
 199       if(invert) cout << "      Invert mapping" << endl;
 200       if (ScheduledBy != 0) {
 201         cout << "      Scheduled by parameter: " << ScheduledBy->getName() << endl;
 202         Table->Print();
 203       }
 204     }
 205   }
 206   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 207     if (from == 0) cout << "Instantiated: FGGain" << endl;
 208     if (from == 1) cout << "Destroyed:    FGGain" << endl;
 209   }
 210   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 211   }
 212   if (debug_lvl & 8 ) { // Runtime state variables
 213   }
 214   if (debug_lvl & 16) { // Sanity checking
 215   }
 216   if (debug_lvl & 64) {
 217     if (from == 0) { // Constructor
 218       cout << IdSrc << endl;
 219       cout << IdHdr << endl;
 220     }
 221   }
 222 }
 223