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