src/FDM/JSBSim/filtersjb/FGSummer.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGSummer.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 "FGSummer.h"
  41
  42 namespace JSBSim {
  43
  44 static const char *IdSrc = "$Id$";
  45 static const char *IdHdr = ID_SUMMER;
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 CLASS IMPLEMENTATION
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51
  52 FGSummer::FGSummer(FGFCS* fcs, FGConfigFile* AC_cfg) : FGFCSComponent(fcs),
  53                                                        AC_cfg(AC_cfg)
  54 {
  55   string token,sOutputIdx;
  56
  57   clip = false;
  58   clipmin = clipmax = 0.0;
  59   Bias = 0.0;
  60
  61   Type = AC_cfg->GetValue("TYPE");
  62   Name = AC_cfg->GetValue("NAME");
  63   AC_cfg->GetNextConfigLine();
  64
  65   while ((token = AC_cfg->GetValue()) != string("/COMPONENT")) {
  66     *AC_cfg >> token;
  67
  68     if (token == "INPUT") {
  69       token = AC_cfg->GetValue("INPUT");
  70       *AC_cfg >> token;
  71
  72       if (token[0] == '-') {
  73         InputSigns.push_back(-1.0);
  74         token.erase(0,1);
  75       } else {
  76         InputSigns.push_back( 1.0);
  77       }
  78
  79       InputNodes.push_back( resolveSymbol(token) );
  80     } else if (token == "CLIPTO") {
  81       *AC_cfg >> clipmin >> clipmax;
  82       if (clipmax > clipmin) {
  83         clip = true;
  84       }
  85     } else if (token == "OUTPUT") {
  86       IsOutput = true;
  87       *AC_cfg >> sOutputIdx;
  88       OutputNode = PropertyManager->GetNode(sOutputIdx);
  89     }
  90   }
  91
  92   FGFCSComponent::bind();
  93
  94   Debug(0);
  95 }
  96
  97 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  98
  99 FGSummer::~FGSummer()
 100 {
 101   Debug(1);
 102 }
 103
 104 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 105
 106 bool FGSummer::Run(void )
 107 {
 108   unsigned int idx;
 109
 110   // The Summer takes several inputs, so do not call the base class Run()
 111   // FGFCSComponent::Run();
 112
 113   Output = 0.0;
 114
 115   for (idx=0; idx<InputNodes.size(); idx++) {
 116     Output += InputNodes[idx]->getDoubleValue()*InputSigns[idx];
 117   }
 118
 119   if (clip) {
 120     if (Output > clipmax)      Output = clipmax;
 121     else if (Output < clipmin) Output = clipmin;
 122   }
 123
 124   if (IsOutput) SetOutput();
 125
 126   return true;
 127 }
 128
 129 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 130 //    The bitmasked value choices are as follows:
 131 //    unset: In this case (the default) JSBSim would only print
 132 //       out the normally expected messages, essentially echoing
 133 //       the config files as they are read. If the environment
 134 //       variable is not set, debug_lvl is set to 1 internally
 135 //    0: This requests JSBSim not to output any messages
 136 //       whatsoever.
 137 //    1: This value explicity requests the normal JSBSim
 138 //       startup messages
 139 //    2: This value asks for a message to be printed out when
 140 //       a class is instantiated
 141 //    4: When this value is set, a message is displayed when a
 142 //       FGModel object executes its Run() method
 143 //    8: When this value is set, various runtime state variables
 144 //       are printed out periodically
 145 //    16: When set various parameters are sanity checked and
 146 //       a message is printed out when they go out of bounds
 147
 148 void FGSummer::Debug(int from)
 149 {
 150   if (debug_lvl <= 0) return;
 151
 152   if (debug_lvl & 1) { // Standard console startup message output
 153     if (from == 0) { // Constructor
 154       cout << "      INPUTS: " << endl;
 155       for (unsigned i=0;i<InputNodes.size();i++) {
 156         cout << "       " << InputNodes[i]->getName() << endl;
 157       }
 158       if (clip) cout << "      CLIPTO: " << clipmin
 159                                   << ", " << clipmax << endl;
 160       if (IsOutput) cout << "      OUTPUT: " <<OutputNode->getName() <<  endl;
 161     }
 162   }
 163   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 164     if (from == 0) cout << "Instantiated: FGSummer" << endl;
 165     if (from == 1) cout << "Destroyed:    FGSummer" << endl;
 166   }
 167   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 168   }
 169   if (debug_lvl & 8 ) { // Runtime state variables
 170   }
 171   if (debug_lvl & 16) { // Sanity checking
 172   }
 173   if (debug_lvl & 64) {
 174     if (from == 0) { // Constructor
 175       cout << IdSrc << endl;
 176       cout << IdHdr << endl;
 177     }
 178   }
 179 }
 180
 181 } //namespace JSBSim
 182