src/FDM/JSBSim/filtersjb/FGFCSComponent.cpp

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Module:       FGFCSComponent.cpp
   4  Author:       Jon S. Berndt
   5  Date started: 11/1999
   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 "FGFCSComponent.h"
  41
  42 static const char *IdSrc = "$Id$";
  43 static const char *IdHdr = ID_FCSCOMPONENT;
  44
  45 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  46 CLASS IMPLEMENTATION
  47 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  48
  49 FGFCSComponent::FGFCSComponent(FGFCS* _fcs) : fcs(_fcs)
  50 {
  51   Type       = "";
  52   ID         = 0;
  53   Input      = 0.0;
  54   InputIdx   = FG_UNDEF;
  55   Output     = 0.0;
  56   sOutputIdx = "";
  57   OutputIdx  = FG_UNDEF;
  58   IsOutput   = false;
  59
  60   Debug(0);
  61 }
  62
  63 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  64
  65 FGFCSComponent::~FGFCSComponent()
  66 {
  67   Debug(1);
  68 }
  69
  70 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  71
  72 void FGFCSComponent::SetOutput(void)
  73 {
  74   fcs->GetState()->SetParameter(OutputIdx, Output);
  75 }
  76
  77 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  78
  79 bool FGFCSComponent::Run(void)
  80 {
  81   switch(InputType) {
  82   case itPilotAC:
  83     Input = fcs->GetState()->GetParameter(InputIdx);
  84     break;
  85   case itFCS:
  86     Input = fcs->GetComponentOutput(InputIdx);
  87     break;
  88   case itAP:
  89     // implement autopilot input mechanism
  90     break;
  91   }
  92
  93   return true;
  94 }
  95
  96 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  97 //    The bitmasked value choices are as follows:
  98 //    unset: In this case (the default) JSBSim would only print
  99 //       out the normally expected messages, essentially echoing
 100 //       the config files as they are read. If the environment
 101 //       variable is not set, debug_lvl is set to 1 internally
 102 //    0: This requests JSBSim not to output any messages
 103 //       whatsoever.
 104 //    1: This value explicity requests the normal JSBSim
 105 //       startup messages
 106 //    2: This value asks for a message to be printed out when
 107 //       a class is instantiated
 108 //    4: When this value is set, a message is displayed when a
 109 //       FGModel object executes its Run() method
 110 //    8: When this value is set, various runtime state variables
 111 //       are printed out periodically
 112 //    16: When set various parameters are sanity checked and
 113 //       a message is printed out when they go out of bounds
 114
 115 void FGFCSComponent::Debug(int from)
 116 {
 117   if (debug_lvl <= 0) return;
 118
 119   if (debug_lvl & 1) { // Standard console startup message output
 120   }
 121   if (debug_lvl & 2 ) { // Instantiation/Destruction notification
 122     if (from == 0) cout << "Instantiated: FGFCSComponent" << endl;
 123     if (from == 1) cout << "Destroyed:    FGFCSComponent" << endl;
 124   }
 125   if (debug_lvl & 4 ) { // Run() method entry print for FGModel-derived objects
 126   }
 127   if (debug_lvl & 8 ) { // Runtime state variables
 128   }
 129   if (debug_lvl & 16) { // Sanity checking
 130   }
 131   if (debug_lvl & 64) {
 132     if (from == 0) { // Constructor
 133       cout << IdSrc << endl;
 134       cout << IdHdr << endl;
 135     }
 136   }
 137 }
 138