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 == "BIAS") {
  81       *AC_cfg >> Bias;
  82     } else if (token == "CLIPTO") {
  83       *AC_cfg >> clipmin >> clipmax;
  84       if (clipmax > clipmin) {
  85         clip = true;
  86       }
  87     } else if (token == "OUTPUT") {
  88       IsOutput = true;
  89       *AC_cfg >> sOutputIdx;
  90       OutputNode = PropertyManager->GetNode(sOutputIdx, true);
  91     }
  92   }
  93
  94   FGFCSComponent::bind();
  95
  96   Debug(0);
  97 }
  98
  99 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 100
 101 FGSummer::~FGSummer()
 102 {
 103   Debug(1);
 104 }
 105
 106 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 107
 108 bool FGSummer::Run(void )
 109 {
 110   unsigned int idx;
 111
 112   // The Summer takes several inputs, so do not call the base class Run()
 113   // FGFCSComponent::Run();
 114
 115   Output = 0.0;
 116
 117   for (idx=0; idx<InputNodes.size(); idx++) {
 118     Output += InputNodes[idx]->getDoubleValue()*InputSigns[idx];
 119   }
 120
 121   Output += Bias;
 122
 123   if (clip) {
 124     if (Output > clipmax)      Output = clipmax;
 125     else if (Output < clipmin) Output = clipmin;
 126   }
 127
 128   if (IsOutput) SetOutput();
 129
 130   return true;
 131 }
 132
 133 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 134
 135 void FGSummer::convert(void)
 136 {
 137   string sSign;
 138
 139   cout << endl;
 140   cout << "        <component name=\"" << Name << "\" type=\"" << Type << "\">" << endl;
 141
 142   for (int i=0; i<InputNodes.size(); i++) {
 143     if (InputSigns[i] < 0.0) sSign = "-";
 144     else                     sSign = "";
 145     cout << "            <input>" << sSign << (InputNodes[i]->GetFullyQualifiedName()).substr(12) << "</input>" << endl;
 146   }
 147
 148   if (Bias != 0.0)
 149     cout << "            <bias>" << Bias << "</bias>" << endl;
 150
 151   if (clip) {
 152     cout << "            <clip>" << endl;
 153     cout << "                <min>" << clipmin << "</min>" << endl;
 154     cout << "                <max>" << clipmax << "</max>" << endl;
 155     cout << "            </clip>" << endl;
 156   }
 157
 158   if (IsOutput)
 159     cout << "            <output>" << (OutputNode->GetFullyQualifiedName()).substr(12) << "</output>" << endl;
 160
 161   cout << "        </component>" << endl;
 162 }
 163
 164 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 165 //    The bitmasked value choices are as follows:
 166 //    unset: In this case (the default) JSBSim would only print
 167 //       out the normally expected messages, essentially echoing
 168 //       the config files as they are read. If the environment
 169 //       variable is not set, debug_lvl is set to 1 internally
 170 //    0: This requests JSBSim not to output any messages
 171 //       whatsoever.
 172 //    1: This value explicity requests the normal JSBSim
 173 //       startup messages
 174 //    2: This value asks for a message to be printed out when
 175 //       a class is instantiated
 176 //    4: When this value is set, a message is displayed when a
 177 //       FGModel object executes its Run() method
 178 //    8: When this value is set, various runtime state variables
 179 //       are printed out periodically
 180 //    16: When set various parameters are sanity checked and
 181 //       a message is printed out when they go out of bounds
 182
 183 void FGSummer::Debug(int from)
 184 {
 185   if (debug_lvl <= 0) return;
 186
 187   if (debug_lvl & 1) { // Standard console startup message output
 188     if (from == 0) { // Constructor
 189       cout << "      INPUTS: " << endl;
 190       for (unsigned i=0;i<InputNodes.size();i++) {
 191         if (InputSigns[i] < 0)
 192           cout << "       -" << InputNodes[i]->getName() << endl;
 193         else
 194           cout << "       " << InputNodes[i]->getName() << endl;
 195       }
 196       if (Bias != 0.0) cout << "       Bias: " << Bias << endl;
 197       if (clip) cout << "      CLIPTO: " << clipmin
 198                                   << ", " << clipmax << endl;
 199       if (IsOutput) cout << "      OUTPUT: " <<OutputNode->getName() <<  endl;
 200     }
 201   }
 202   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 203     if (from == 0) cout << "Instantiated: FGSummer" << endl;
 204     if (from == 1) cout << "Destroyed:    FGSummer" << endl;
 205   }
 206   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 207   }
 208   if (debug_lvl & 8 ) { // Runtime state variables
 209   }
 210   if (debug_lvl & 16) { // Sanity checking
 211   }
 212   if (debug_lvl & 64) {
 213     if (from == 0) { // Constructor
 214       cout << IdSrc << endl;
 215       cout << IdHdr << endl;
 216     }
 217   }
 218 }
 219
 220 } //namespace JSBSim
 221