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