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   if (debug_lvl > 0) {
  94     cout << "      ID: " << ID << endl;
  95     cout << "      INPUTS: " << endl;
  96     for (unsigned i=0;i<InputIndices.size();i++) {
  97       cout << "        " << InputIndices[i] << endl;
  98     }
  99     if (clipmax > clipmin) cout << "      CLIPTO: " << clipmin
 100                                 << ", " << clipmax << endl;
 101     if (IsOutput) cout << "      OUTPUT: " <<sOutputIdx <<  endl;
 102   }
 103
 104   if (debug_lvl & 2) cout << "Instantiated: FGSummer" << endl;
 105 }
 106
 107 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 108
 109 FGSummer::~FGSummer()
 110 {
 111   if (debug_lvl & 2) cout << "Destroyed:    FGSummer" << endl;
 112 }
 113
 114 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 115
 116 bool FGSummer::Run(void )
 117 {
 118   unsigned int idx;
 119
 120   // The Summer takes several inputs, so do not call the base class Run()
 121   // FGFCSComponent::Run();
 122
 123   Output = 0.0;
 124
 125   for (idx=0; idx<InputIndices.size(); idx++) {
 126     switch (InputTypes[idx]) {
 127     case itPilotAC:
 128       Output += fcs->GetState()->GetParameter(InputIndices[idx]);
 129       break;
 130     case itFCS:
 131       Output += fcs->GetComponentOutput(InputIndices[idx]);
 132       break;
 133     }
 134   }
 135
 136   if (clip) {
 137     if (Output > clipmax)      Output = clipmax;
 138     else if (Output < clipmin) Output = clipmin;
 139   }
 140
 141   if (IsOutput) SetOutput();
 142
 143   return true;
 144 }
 145
 146 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 147
 148 void FGSummer::Debug(void)
 149 {
 150     //TODO: Add your source code here
 151 }
 152