src/FDM/JSBSim/FGModel.h

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:       FGModel.h
   4  Author:       Jon Berndt
   5  Date started: 11/21/98
   6
   7  ------------- Copyright (C) 1999  Jon S. Berndt (jsb@hal-pc.org) -------------
   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 HISTORY
  27 --------------------------------------------------------------------------------
  28 11/22/98   JSB   Created
  29
  30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31 SENTRY
  32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  33
  34 #ifndef FGMODEL_H
  35 #define FGMODEL_H
  36
  37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  38 INCLUDES
  39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  40
  41 #include "FGJSBBase.h"
  42 #include "FGPropertyManager.h"
  43
  44 #ifdef FGFS
  45 #  include <simgear/compiler.h>
  46 #  ifdef SG_HAVE_STD_INCLUDES
  47 #    include <iostream>
  48 #  else
  49 #    include <iostream.h>
  50 #  endif
  51 #else
  52 #  if defined(sgi) && !defined(__GNUC__)
  53 #    include <iostream.h>
  54 #  else
  55 #    include <iostream>
  56 #  endif
  57 #endif
  58
  59 #include <string>
  60
  61 #define ID_MODEL "$Id$"
  62
  63 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  64 DEFINITIONS
  65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  66
  67 using namespace std;
  68
  69 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  70 FORWARD DECLARATIONS
  71 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  72
  73 namespace JSBSim {
  74
  75 class FGFDMExec;
  76 class FGState;
  77 class FGAtmosphere;
  78 class FGFCS;
  79 class FGPropulsion;
  80 class FGMassBalance;
  81 class FGAerodynamics;
  82 class FGInertial;
  83 class FGGroundReactions;
  84 class FGAircraft;
  85 class FGTranslation;
  86 class FGRotation;
  87 class FGPosition;
  88 class FGAuxiliary;
  89 class FGOutput;
  90 class FGConfigFile;
  91
  92 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  93 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  94 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  95
  96 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  97 CLASS DOCUMENTATION
  98 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  99
 100 /** Base class for all scheduled JSBSim models
 101     @author Jon S. Berndt
 102     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGModel.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
 103          Header File </a>
 104     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGModel.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
 105          Source File </a>
 106   */
 107
 108 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 109 CLASS DECLARATION
 110 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 111
 112 class FGModel : public FGJSBBase
 113 {
 114 public:
 115
 116   /// Constructor
 117   FGModel(FGFDMExec*);
 118   /// Destructor
 119   virtual ~FGModel();
 120
 121   /** Loads this model.
 122       @param Config a pointer to the config file instance
 123       @return true if model is successfully loaded*/
 124   virtual bool Load(FGConfigFile* Config) {return true;}
 125
 126   FGModel* NextModel;
 127   string Name;
 128
 129   /** Runs the model; called by the Executive
 130       @see JSBSim.cpp documentation
 131       @return false if no error */
 132   virtual bool Run(void);
 133   virtual bool InitModel(void);
 134   virtual void SetRate(int tt) {rate = tt;}
 135   virtual int  GetRate(void)   {return rate;}
 136
 137   void SetPropertyManager(FGPropertyManager *fgpm) { PropertyManager=fgpm;}
 138
 139 protected:
 140   int exe_ctr;
 141   int rate;
 142
 143   virtual void Debug(int from);
 144
 145   FGFDMExec*         FDMExec;
 146   FGState*           State;
 147   FGAtmosphere*      Atmosphere;
 148   FGFCS*             FCS;
 149   FGPropulsion*      Propulsion;
 150   FGMassBalance*     MassBalance;
 151   FGAerodynamics*    Aerodynamics;
 152   FGInertial*        Inertial;
 153   FGGroundReactions* GroundReactions;
 154   FGAircraft*        Aircraft;
 155   FGTranslation*     Translation;
 156   FGRotation*        Rotation;
 157   FGPosition*        Position;
 158   FGAuxiliary*       Auxiliary;
 159   FGOutput*          Output;
 160   FGPropertyManager* PropertyManager;
 161 };
 162 }
 163 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 164 #endif
 165