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