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 FG_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 FGAircraft;
  74 class FGTranslation;
  75 class FGRotation;
  76 class FGPosition;
  77 class FGAuxiliary;
  78 class FGOutput;
  79
  80 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  81 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  82 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  83
  84 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  85 CLASS DOCUMENTATION
  86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  87
  88 /** Base class for all scheduled JSBSim models
  89     @author Jon S. Berndt
  90   */
  91
  92 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  93 CLASS DECLARATION
  94 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  95
  96 class FGModel
  97 {
  98 public:
  99
 100   /// Constructor
 101   FGModel(FGFDMExec*);
 102   /// Destructor
 103   virtual ~FGModel();
 104
 105   FGModel* NextModel;
 106   string Name;
 107
 108     /** Runs the model; called by the Executive
 109       @see JSBSim.cpp documentation
 110       @return false if no error */
 111   virtual bool Run(void);
 112   virtual bool InitModel(void);
 113   virtual void SetRate(int tt) {rate = tt;}
 114   virtual int  GetRate(void)   {return rate;}
 115
 116 protected:
 117   enum {eU=1, eV, eW};
 118   enum {eNorth=1, eEast, eDown};
 119   enum {eP=1, eQ, eR};
 120   enum {eL=1, eM, eN};
 121   enum {eX=1, eY, eZ};
 122   enum {ePhi=1, eTht, ePsi};
 123
 124   int exe_ctr;
 125   int rate;
 126
 127   FGFDMExec*      FDMExec;
 128   FGState*        State;
 129   FGAtmosphere*   Atmosphere;
 130   FGFCS*          FCS;
 131   FGPropulsion*   Propulsion;
 132   FGAircraft*     Aircraft;
 133   FGTranslation*  Translation;
 134   FGRotation*     Rotation;
 135   FGPosition*     Position;
 136   FGAuxiliary*    Auxiliary;
 137   FGOutput*       Output;
 138   virtual void Debug(void);
 139 };
 140
 141 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 142 #endif
 143