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