src/FDM/JSBSim/filtersjb/FGGradient.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGGradient.cpp
   4  Author:
   5  Date started:
   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 "FGGradient.h"
  41
  42 namespace JSBSim {
  43
  44 static const char *IdSrc = "$Id$";
  45 static const char *IdHdr = ID_GRADIENT;
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 CLASS IMPLEMENTATION
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51
  52 FGGradient::FGGradient(FGFCS* fcs, FGConfigFile* AC_cfg) : FGFCSComponent(fcs),
  53                                                            AC_cfg(AC_cfg)
  54 {
  55   Type = AC_cfg->GetValue("TYPE");
  56   Name = AC_cfg->GetValue("NAME");
  57
  58   FGFCSComponent::bind();
  59
  60   Debug(0);
  61 }
  62
  63 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  64
  65 FGGradient::~FGGradient()
  66 {
  67   Debug(1);
  68 }
  69
  70 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  71
  72 bool FGGradient::Run(void )
  73 {
  74   FGFCSComponent::Run(); // call the base class for initialization of Input
  75
  76   return true;
  77 }
  78
  79 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  80 //    The bitmasked value choices are as follows:
  81 //    unset: In this case (the default) JSBSim would only print
  82 //       out the normally expected messages, essentially echoing
  83 //       the config files as they are read. If the environment
  84 //       variable is not set, debug_lvl is set to 1 internally
  85 //    0: This requests JSBSim not to output any messages
  86 //       whatsoever.
  87 //    1: This value explicity requests the normal JSBSim
  88 //       startup messages
  89 //    2: This value asks for a message to be printed out when
  90 //       a class is instantiated
  91 //    4: When this value is set, a message is displayed when a
  92 //       FGModel object executes its Run() method
  93 //    8: When this value is set, various runtime state variables
  94 //       are printed out periodically
  95 //    16: When set various parameters are sanity checked and
  96 //       a message is printed out when they go out of bounds
  97
  98 void FGGradient::Debug(int from)
  99 {
 100   if (debug_lvl <= 0) return;
 101
 102   if (debug_lvl & 1) { // Standard console startup message output
 103     if (from == 0) { // Constructor
 104
 105     }
 106   }
 107   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 108     if (from == 0) cout << "Instantiated: FGGradient" << endl;
 109     if (from == 1) cout << "Destroyed:    FGGradient" << endl;
 110   }
 111   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 112   }
 113   if (debug_lvl & 8 ) { // Runtime state variables
 114   }
 115   if (debug_lvl & 16) { // Sanity checking
 116   }
 117   if (debug_lvl & 64) {
 118     if (from == 0) { // Constructor
 119       cout << IdSrc << endl;
 120       cout << IdHdr << endl;
 121     }
 122   }
 123 }
 124 }