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