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 "$Header$"
  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 FGAircraft;
  73 class FGTranslation;
  74 class FGRotation;
  75 class FGPosition;
  76 class FGAuxiliary;
  77 class FGOutput;
  78
  79 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  80 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
  81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  82
  83 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  84 CLASS DOCUMENTATION
  85 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  86
  87 /** Base class for all scheduled JSBSim models
  88     @author Jon S. Berndt
  89   */
  90
  91 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  92 CLASS DECLARATION
  93 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  94
  95 class FGModel
  96 {
  97 public:
  98
  99   /// Constructor
 100   FGModel(FGFDMExec*);
 101   /// Destructor
 102   virtual ~FGModel(void);
 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
 115 protected:
 116   enum {eU=1, eV, eW};
 117   enum {eNorth=1, eEast, eDown};
 118   enum {eP=1, eQ, eR};
 119   enum {eL=1, eM, eN};
 120   enum {eX=1, eY, eZ};
 121   enum {ePhi=1, eTht, ePsi};
 122
 123   int exe_ctr;
 124   int rate;
 125
 126   FGFDMExec*      FDMExec;
 127   FGState*        State;
 128   FGAtmosphere*   Atmosphere;
 129   FGFCS*          FCS;
 130   FGAircraft*     Aircraft;
 131   FGTranslation*  Translation;
 132   FGRotation*     Rotation;
 133   FGPosition*     Position;
 134   FGAuxiliary*    Auxiliary;
 135   FGOutput*       Output;
 136
 137 private:
 138 };
 139
 140 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 141 #endif