src/FDM/JSBSim/models/flight_control/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 FGSummer::FGSummer(FGFCS* fcs, Element* element) : FGFCSComponent(fcs, element)
  52 {
  53   Bias = 0.0;
  54
  55   if (element->FindElement("bias")) Bias = element->FindElementValueAsNumber("bias");
  56
  57   FGFCSComponent::bind();
  58
  59   Debug(0);
  60 }
  61
  62 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  63
  64 FGSummer::~FGSummer()
  65 {
  66   Debug(1);
  67 }
  68
  69 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  70
  71 bool FGSummer::Run(void )
  72 {
  73   unsigned int idx;
  74
  75   Output = 0.0;
  76
  77   for (idx=0; idx<InputNodes.size(); idx++) {
  78     Output += InputNodes[idx]->getDoubleValue() * InputSigns[idx];
  79   }
  80
  81   Output += Bias;
  82
  83   Clip();
  84   if (IsOutput) SetOutput();
  85
  86   return true;
  87 }
  88
  89 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  90 //    The bitmasked value choices are as follows:
  91 //    unset: In this case (the default) JSBSim would only print
  92 //       out the normally expected messages, essentially echoing
  93 //       the config files as they are read. If the environment
  94 //       variable is not set, debug_lvl is set to 1 internally
  95 //    0: This requests JSBSim not to output any messages
  96 //       whatsoever.
  97 //    1: This value explicity requests the normal JSBSim
  98 //       startup messages
  99 //    2: This value asks for a message to be printed out when
 100 //       a class is instantiated
 101 //    4: When this value is set, a message is displayed when a
 102 //       FGModel object executes its Run() method
 103 //    8: When this value is set, various runtime state variables
 104 //       are printed out periodically
 105 //    16: When set various parameters are sanity checked and
 106 //       a message is printed out when they go out of bounds
 107
 108 void FGSummer::Debug(int from)
 109 {
 110   if (debug_lvl <= 0) return;
 111
 112   if (debug_lvl & 1) { // Standard console startup message output
 113     if (from == 0) { // Constructor
 114       cout << "      INPUTS: " << endl;
 115       for (unsigned i=0;i<InputNodes.size();i++) {
 116         if (InputSigns[i] < 0)
 117           cout << "       -" << InputNodes[i]->getName() << endl;
 118         else
 119           cout << "       " << InputNodes[i]->getName() << endl;
 120       }
 121       if (Bias != 0.0) cout << "       Bias: " << Bias << endl;
 122       if (clip) cout << "      CLIPTO: " << clipmin
 123                                   << ", " << clipmax << endl;
 124       if (IsOutput) cout << "      OUTPUT: " <<OutputNode->getName() <<  endl;
 125     }
 126   }
 127   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 128     if (from == 0) cout << "Instantiated: FGSummer" << endl;
 129     if (from == 1) cout << "Destroyed:    FGSummer" << endl;
 130   }
 131   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 132   }
 133   if (debug_lvl & 8 ) { // Runtime state variables
 134   }
 135   if (debug_lvl & 16) { // Sanity checking
 136   }
 137   if (debug_lvl & 64) {
 138     if (from == 0) { // Constructor
 139       cout << IdSrc << endl;
 140       cout << IdHdr << endl;
 141     }
 142   }
 143 }
 144
 145 } //namespace JSBSim
 146