src/FDM/JSBSim/models/flight_control/FGGyro.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGGyro.cpp
   4  Author:       Jon Berndt
   5  Date started: 29 August 2009
   6
   7  ------------- Copyright (C) 2009 -------------
   8
   9  This program is free software; you can redistribute it and/or modify it under
  10  the terms of the GNU Lesser 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 Lesser General Public License for more
  17  details.
  18
  19  You should have received a copy of the GNU Lesser 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 Lesser 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 "FGGyro.h"
  41 #include <iostream>
  42
  43 #include "models/FGAccelerations.h"
  44
  45 using namespace std;
  46
  47 namespace JSBSim {
  48
  49 static const char *IdSrc = "$Id: FGGyro.cpp,v 1.6 2011/07/17 13:51:23 jberndt Exp $";
  50 static const char *IdHdr = ID_GYRO;
  51
  52 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  53 CLASS IMPLEMENTATION
  54 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  55
  56 FGGyro::FGGyro(FGFCS* fcs, Element* element) : FGSensor(fcs, element),
  57                                                FGSensorOrientation(element)
  58 {
  59   Accelerations = fcs->GetExec()->GetAccelerations();
  60
  61   Debug(0);
  62 }
  63
  64 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  65
  66 FGGyro::~FGGyro()
  67 {
  68   Debug(1);
  69 }
  70
  71 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  72
  73 bool FGGyro::Run(void )
  74 {
  75   // There is no input assumed. This is a dedicated angular acceleration sensor.
  76
  77   //aircraft rates
  78   vAccel = mT * Accelerations->GetPQRdot();
  79
  80   Input = vAccel(axis);
  81
  82   ProcessSensorSignal();
  83
  84   return true;
  85 }
  86
  87 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  88 //    The bitmasked value choices are as follows:
  89 //    unset: In this case (the default) JSBSim would only print
  90 //       out the normally expected messages, essentially echoing
  91 //       the config files as they are read. If the environment
  92 //       variable is not set, debug_lvl is set to 1 internally
  93 //    0: This requests JSBSim not to output any messages
  94 //       whatsoever.
  95 //    1: This value explicity requests the normal JSBSim
  96 //       startup messages
  97 //    2: This value asks for a message to be printed out when
  98 //       a class is instantiated
  99 //    4: When this value is set, a message is displayed when a
 100 //       FGModel object executes its Run() method
 101 //    8: When this value is set, various runtime state variables
 102 //       are printed out periodically
 103 //    16: When set various parameters are sanity checked and
 104 //       a message is printed out when they go out of bounds
 105
 106 void FGGyro::Debug(int from)
 107 {
 108   string ax[4] = {"none", "X", "Y", "Z"};
 109
 110   if (debug_lvl <= 0) return;
 111
 112   if (debug_lvl & 1) { // Standard console startup message output
 113     if (from == 0) { // Constructor
 114       cout << "        Axis: " << ax[axis] << endl;
 115     }
 116   }
 117   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 118     if (from == 0) cout << "Instantiated: FGGyro" << endl;
 119     if (from == 1) cout << "Destroyed:    FGGyro" << endl;
 120   }
 121   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 122   }
 123   if (debug_lvl & 8 ) { // Runtime state variables
 124   }
 125   if (debug_lvl & 16) { // Sanity checking
 126   }
 127   if (debug_lvl & 64) {
 128     if (from == 0) { // Constructor
 129       cout << IdSrc << endl;
 130       cout << IdHdr << endl;
 131     }
 132   }
 133 }
 134 }