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