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 "FGJSBBase.h"
  42 #include "math/FGFunction.h"
  43
  44 #include <string>
  45 #include <vector>
  46
  47 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  48 DEFINITIONS
  49 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  50
  51 #define ID_MODEL "$Id: FGModel.h,v 1.14 2009/11/12 13:08:11 jberndt Exp $"
  52
  53 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  54 FORWARD DECLARATIONS
  55 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  56
  57 namespace JSBSim {
  58
  59 class FGFDMExec;
  60 class FGState;
  61 class FGAtmosphere;
  62 class FGFCS;
  63 class FGPropulsion;
  64 class FGMassBalance;
  65 class FGAerodynamics;
  66 class FGInertial;
  67 class FGGroundReactions;
  68 class FGExternalReactions;
  69 class FGBuoyantForces;
  70 class FGAircraft;
  71 class FGPropagate;
  72 class FGAuxiliary;
  73 class Element;
  74 class FGPropertyManager;
  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   ~FGModel();
  96
  97   FGModel* NextModel;
  98   std::string Name;
  99
 100   /** Runs the model; called by the Executive
 101       @see JSBSim.cpp documentation
 102       @return false if no error */
 103   virtual bool Run(void);
 104   virtual bool InitModel(void);
 105   virtual void SetRate(int tt) {rate = tt;}
 106   virtual int  GetRate(void)   {return rate;}
 107   FGFDMExec* GetExec(void)     {return FDMExec;}
 108
 109   void SetPropertyManager(FGPropertyManager *fgpm) { PropertyManager=fgpm;}
 110
 111 protected:
 112   int exe_ctr;
 113   int rate;
 114
 115   void RunPreFunctions(void);
 116   void RunPostFunctions(void);
 117
 118   /** Loads this model.
 119       @param el a pointer to the element
 120       @return true if model is successfully loaded*/
 121   virtual bool Load(Element* el);
 122
 123   void PostLoad(Element* el);
 124
 125   virtual void Debug(int from);
 126
 127   FGFDMExec*         FDMExec;
 128   FGState*           State;
 129   FGAtmosphere*      Atmosphere;
 130   FGFCS*             FCS;
 131   FGPropulsion*      Propulsion;
 132   FGMassBalance*     MassBalance;
 133   FGAerodynamics*    Aerodynamics;
 134   FGInertial*        Inertial;
 135   FGGroundReactions* GroundReactions;
 136   FGExternalReactions* ExternalReactions;
 137   FGBuoyantForces*   BuoyantForces;
 138   FGAircraft*        Aircraft;
 139   FGPropagate*       Propagate;
 140   FGAuxiliary*       Auxiliary;
 141   FGPropertyManager* PropertyManager;
 142   std::vector <FGFunction*> PreFunctions;
 143   std::vector <FGFunction*> PostFunctions;
 144
 145   std::vector <double*> interface_properties;
 146 };
 147 }
 148 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 149 #endif
 150