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