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