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