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

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGFCSFunction.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 6/2005
   6
   7  ------------- Copyright (C) 2005 -------------
   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 "FGFCSFunction.h"
  41
  42 namespace JSBSim {
  43
  44 static const char *IdSrc = "$Id$";
  45 static const char *IdHdr = ID_FCSFUNCTION;
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 CLASS IMPLEMENTATION
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  52
  53 FGFCSFunction::FGFCSFunction(FGFCS* fcs, Element* element) : FGFCSComponent(fcs, element)
  54 {
  55   Element *function_element = element->FindElement("function");
  56
  57   if (function_element)
  58     function = new FGFunction(PropertyManager, function_element);
  59   else {
  60     cerr << "FCS Function should contain a \"function\" element" << endl;
  61     exit(-1);
  62   }
  63
  64   FGFCSComponent::bind();
  65   Debug(0);
  66 }
  67
  68 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  69
  70 FGFCSFunction::~FGFCSFunction()
  71 {
  72   Debug(1);
  73 }
  74
  75 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76
  77 bool FGFCSFunction::Run(void )
  78 {
  79   Output = function->GetValue();
  80
  81   if (InputNodes.size() > 0) {
  82     Input = InputNodes[0]->getDoubleValue() * InputSigns[0];
  83     Output*= Input;
  84   }
  85
  86   Clip();
  87
  88   if (IsOutput) SetOutput();
  89
  90   return true;
  91 }
  92
  93 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  94 //    The bitmasked value choices are as follows:
  95 //    unset: In this case (the default) JSBSim would only print
  96 //       out the normally expected messages, essentially echoing
  97 //       the config files as they are read. If the environment
  98 //       variable is not set, debug_lvl is set to 1 internally
  99 //    0: This requests JSBSim not to output any messages
 100 //       whatsoever.
 101 //    1: This value explicity requests the normal JSBSim
 102 //       startup messages
 103 //    2: This value asks for a message to be printed out when
 104 //       a class is instantiated
 105 //    4: When this value is set, a message is displayed when a
 106 //       FGModel object executes its Run() method
 107 //    8: When this value is set, various runtime state variables
 108 //       are printed out periodically
 109 //    16: When set various parameters are sanity checked and
 110 //       a message is printed out when they go out of bounds
 111
 112 void FGFCSFunction::Debug(int from)
 113 {
 114   if (debug_lvl <= 0) return;
 115
 116   if (debug_lvl & 1) { // Standard console startup message output
 117     if (from == 0) { // Constructor
 118       if (InputNodes.size()>0)
 119         cout << "      INPUT: " << InputNodes[0]->getName() << endl;
 120 //    cout << "      Function: " << endl;
 121       if (clip) cout << "      CLIPTO: " << clipmin
 122                                   << ", " << clipmax << endl;
 123       if (IsOutput) cout << "      OUTPUT: " << OutputNode->getName() << endl;
 124     }
 125   }
 126   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 127     if (from == 0) cout << "Instantiated: FGFCSFunction" << endl;
 128     if (from == 1) cout << "Destroyed:    FGFCSFunction" << endl;
 129   }
 130   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 131   }
 132   if (debug_lvl & 8 ) { // Runtime state variables
 133   }
 134   if (debug_lvl & 16) { // Sanity checking
 135   }
 136   if (debug_lvl & 64) {
 137     if (from == 0) { // Constructor
 138       cout << IdSrc << endl;
 139       cout << IdHdr << endl;
 140     }
 141   }
 142 }
 143 }