src/FDM/JSBSim/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 "FGDefs.h"
  42
  43 #ifdef FGFS
  44 #  include <simgear/compiler.h>
  45 #  ifdef SG_HAVE_STD_INCLUDES
  46 #    include <iostream>
  47 #  else
  48 #    include <iostream.h>
  49 #  endif
  50 #else
  51 #  include <iostream>
  52 #endif
  53
  54 #include <string>
  55
  56 #define ID_MODEL "$Id$"
  57
  58 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  59 DEFINITIONS
  60 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  61
  62 using namespace std;
  63
  64 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  65 FORWARD DECLARATIONS
  66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  67
  68 class FGFDMExec;
  69 class FGState;
  70 class FGAtmosphere;
  71 class FGFCS;
  72 class FGPropulsion;
  73 class FGMassBalance;
  74 class FGAerodynamics;
  75 class FGInertial;
  76 class FGAircraft;
  77 class FGTranslation;
  78 class FGRotation;
  79 class FGPosition;
  80 class FGAuxiliary;
  81 class FGOutput;
  82 class FGConfigFile;
  83
  84 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  85 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  87
  88 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  89 CLASS DOCUMENTATION
  90 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  91
  92 /** Base class for all scheduled JSBSim models
  93     @author Jon S. Berndt
  94   */
  95
  96 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  97 CLASS DECLARATION
  98 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  99
 100 class FGModel
 101 {
 102 public:
 103
 104   /// Constructor
 105   FGModel(FGFDMExec*);
 106   /// Destructor
 107   virtual ~FGModel();
 108
 109   /** Loads this model.
 110       @param Config a pointer to the config file instance
 111       @return true if model is successfully loaded*/
 112   virtual bool Load(FGConfigFile* Config) {}
 113
 114   FGModel* NextModel;
 115   string Name;
 116
 117   /** Runs the model; called by the Executive
 118       @see JSBSim.cpp documentation
 119       @return false if no error */
 120   virtual bool Run(void);
 121   virtual bool InitModel(void);
 122   virtual void SetRate(int tt) {rate = tt;}
 123   virtual int  GetRate(void)   {return rate;}
 124
 125 protected:
 126   enum {eU=1, eV, eW};
 127   enum {eNorth=1, eEast, eDown};
 128   enum {eP=1, eQ, eR};
 129   enum {eL=1, eM, eN};
 130   enum {eX=1, eY, eZ};
 131   enum {ePhi=1, eTht, ePsi};
 132
 133   int exe_ctr;
 134   int rate;
 135
 136   FGFDMExec*      FDMExec;
 137   FGState*        State;
 138   FGAtmosphere*   Atmosphere;
 139   FGFCS*          FCS;
 140   FGPropulsion*   Propulsion;
 141   FGMassBalance*  MassBalance;
 142   FGAerodynamics* Aerodynamics;
 143   FGInertial*     Inertial;
 144   FGAircraft*     Aircraft;
 145   FGTranslation*  Translation;
 146   FGRotation*     Rotation;
 147   FGPosition*     Position;
 148   FGAuxiliary*    Auxiliary;
 149   FGOutput*       Output;
 150   virtual void Debug(void);
 151 };
 152
 153 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 154 #endif
 155