src/FDM/JSBSim/FGTurboProp.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGTurboProp.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 11/20/2000
   6  Purpose:      This module models a Turboprop engine
   7
   8  ------------- Copyright (C) 2000  Jon S. Berndt (jsb@hal-pc.org) --------------
   9
  10  This program is free software; you can redistribute it and/or modify it under
  11  the terms of the GNU General Public License as published by the Free Software
  12  Foundation; either version 2 of the License, or (at your option) any later
  13  version.
  14
  15  This program is distributed in the hope that it will be useful, but WITHOUT
  16  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  details.
  19
  20  You should have received a copy of the GNU General Public License along with
  21  this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  22  Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24  Further information about the GNU General Public License can also be found on
  25  the world wide web at http://www.gnu.org.
  26
  27 FUNCTIONAL DESCRIPTION
  28 --------------------------------------------------------------------------------
  29
  30 This class descends from the FGEngine class and models a Turboprop engine based
  31 on parameters given in the engine config file for this class
  32
  33 HISTORY
  34 --------------------------------------------------------------------------------
  35 11/20/2000  JSB  Created
  36
  37 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGTurboProp.h"
  42
  43 static const char *IdSrc = "$Id$";
  44 static const char *IdHdr = ID_TURBOPROP;
  45
  46 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  47 CLASS IMPLEMENTATION
  48 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  49
  50 FGTurboProp::FGTurboProp(FGFDMExec* exec, FGConfigFile* cfg) : FGEngine(exec)
  51 {
  52   Debug(0);
  53 }
  54
  55 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  56
  57 FGTurboProp::~FGTurboProp()
  58 {
  59   Debug(1);
  60 }
  61
  62 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  63
  64 double FGTurboProp::Calculate(double dummy)
  65 {
  66   ConsumeFuel();
  67   return 0.0;
  68 }
  69
  70 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  71 //    The bitmasked value choices are as follows:
  72 //    unset: In this case (the default) JSBSim would only print
  73 //       out the normally expected messages, essentially echoing
  74 //       the config files as they are read. If the environment
  75 //       variable is not set, debug_lvl is set to 1 internally
  76 //    0: This requests JSBSim not to output any messages
  77 //       whatsoever.
  78 //    1: This value explicity requests the normal JSBSim
  79 //       startup messages
  80 //    2: This value asks for a message to be printed out when
  81 //       a class is instantiated
  82 //    4: When this value is set, a message is displayed when a
  83 //       FGModel object executes its Run() method
  84 //    8: When this value is set, various runtime state variables
  85 //       are printed out periodically
  86 //    16: When set various parameters are sanity checked and
  87 //       a message is printed out when they go out of bounds
  88
  89 void FGTurboProp::Debug(int from)
  90 {
  91   if (debug_lvl <= 0) return;
  92
  93   if (debug_lvl & 1) { // Standard console startup message output
  94     if (from == 0) { // Constructor
  95
  96     }
  97   }
  98   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
  99     if (from == 0) cout << "Instantiated: FGTurboProp" << endl;
 100     if (from == 1) cout << "Destroyed:    FGTurboProp" << endl;
 101   }
 102   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 103   }
 104   if (debug_lvl & 8 ) { // Runtime state variables
 105   }
 106   if (debug_lvl & 16) { // Sanity checking
 107   }
 108   if (debug_lvl & 64) {
 109     if (from == 0) { // Constructor
 110       cout << IdSrc << endl;
 111       cout << IdHdr << endl;
 112     }
 113   }
 114 }
 115