src/FDM/JSBSim/models/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 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 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 <input_output/FGPropertyManager.h>
  43 #include <input_output/FGXMLElement.h>
  44
  45 #include <iostream>
  46 #include <string>
  47
  48 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  49 DEFINITIONS
  50 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  51
  52 #define ID_MODEL "$Id$"
  53
  54 using namespace std;
  55
  56 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  57 FORWARD DECLARATIONS
  58 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  59
  60 namespace JSBSim {
  61
  62 class FGFDMExec;
  63 class FGState;
  64 class FGAtmosphere;
  65 class FGFCS;
  66 class FGPropulsion;
  67 class FGMassBalance;
  68 class FGAerodynamics;
  69 class FGInertial;
  70 class FGGroundReactions;
  71 class FGExternalReactions;
  72 class FGBuoyantForces;
  73 class FGAircraft;
  74 class FGPropagate;
  75 class FGAuxiliary;
  76
  77 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  78 CLASS DOCUMENTATION
  79 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  80
  81 /** Base class for all scheduled JSBSim models
  82     @author Jon S. Berndt
  83   */
  84
  85 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  86 CLASS DECLARATION
  87 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  88
  89 class FGModel : public FGJSBBase
  90 {
  91 public:
  92
  93   /// Constructor
  94   FGModel(FGFDMExec*);
  95   /// Destructor
  96   virtual ~FGModel();
  97
  98   /** Loads this model.
  99       @param el a pointer to the element
 100       @return true if model is successfully loaded*/
 101   virtual bool Load(Element* el) {return true;}
 102
 103   FGModel* NextModel;
 104   string Name;
 105
 106   /** Runs the model; called by the Executive
 107       @see JSBSim.cpp documentation
 108       @return false if no error */
 109   virtual bool Run(void);
 110   virtual bool InitModel(void);
 111   virtual void SetRate(int tt) {rate = tt;}
 112   virtual int  GetRate(void)   {return rate;}
 113   FGFDMExec* GetExec(void)     {return FDMExec;}
 114
 115   void SetPropertyManager(FGPropertyManager *fgpm) { PropertyManager=fgpm;}
 116
 117 protected:
 118   int exe_ctr;
 119   int rate;
 120
 121   virtual void Debug(int from);
 122
 123   FGFDMExec*         FDMExec;
 124   FGState*           State;
 125   FGAtmosphere*      Atmosphere;
 126   FGFCS*             FCS;
 127   FGPropulsion*      Propulsion;
 128   FGMassBalance*     MassBalance;
 129   FGAerodynamics*    Aerodynamics;
 130   FGInertial*        Inertial;
 131   FGGroundReactions* GroundReactions;
 132   FGExternalReactions* ExternalReactions;
 133   FGBuoyantForces*   BuoyantForces;
 134   FGAircraft*        Aircraft;
 135   FGPropagate*       Propagate;
 136   FGAuxiliary*       Auxiliary;
 137   FGPropertyManager* PropertyManager;
 138 };
 139 }
 140 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 141 #endif
 142