src/FDM/JSBSim/FGFDMExec.h

   1 /*******************************************************************************
   2
   3  Header:       FGFDMExec.h
   4  Author:       Jon Berndt
   5  Date started: 11/17/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/17/98   JSB   Created
  29 7/31/99     TP   Added RunIC function that runs the sim so that every frame
  30                  begins with the IC values from the given FGInitialCondition
  31                                    object and dt=0.
  32
  33 ********************************************************************************
  34 SENTRY
  35 *******************************************************************************/
  36
  37 #ifndef FGFDMEXEC_HEADER_H
  38 #define FGFDMEXEC_HEADER_H
  39
  40 /*******************************************************************************
  41 INCLUDES
  42 *******************************************************************************/
  43
  44 #include "FGModel.h"
  45 #include "FGInitialCondition.h"
  46
  47 /*******************************************************************************
  48 CLASS DECLARATION
  49 *******************************************************************************/
  50
  51 class FGState;
  52 class FGAtmosphere;
  53 class FGFCS;
  54 class FGAircraft;
  55 class FGTranslation;
  56 class FGRotation;
  57 class FGPosition;
  58 class FGAuxiliary;
  59 class FGOutput;
  60 class FGInitialCondition;
  61
  62 class FGFDMExec
  63 {
  64 public:
  65   FGFDMExec(void);
  66   ~FGFDMExec(void);
  67
  68   FGModel* FirstModel;
  69
  70   bool Initialize(void);
  71   int  Schedule(FGModel* model, int rate);
  72   bool Run(void);
  73   bool RunIC(FGInitialCondition *fgic);
  74   void Freeze(void) {frozen = true;}
  75   void Resume(void) {frozen = false;}
  76
  77   bool SetEnginePath(string path)   {EnginePath = path;}
  78   bool SetAircraftPath(string path) {AircraftPath = path;}
  79   bool SetScriptPath(string path)   {ScriptPath = path;}
  80
  81   bool LoadModel(string AircraftPath, string EnginePath, string model);
  82   bool RunScript(string script);
  83
  84   inline FGState* GetState(void)             {return State;}
  85   inline FGAtmosphere* GetAtmosphere(void)   {return Atmosphere;}
  86   inline FGFCS* GetFCS(void)                 {return FCS;}
  87   inline FGAircraft* GetAircraft(void)       {return Aircraft;}
  88   inline FGTranslation* GetTranslation(void) {return Translation;}
  89   inline FGRotation* GetRotation(void)       {return Rotation;}
  90   inline FGPosition* GetPosition(void)       {return Position;}
  91   inline FGAuxiliary* GetAuxiliary(void)     {return Auxiliary;}
  92   inline FGOutput* GetOutput(void)           {return Output;}
  93
  94
  95
  96 private:
  97   bool frozen;
  98   bool terminate;
  99   bool allocated;
 100   int Error;
 101
 102   string AircraftPath;
 103   string EnginePath;
 104   string ScriptPath;
 105
 106
 107   FGState*       State;
 108   FGAtmosphere*  Atmosphere;
 109   FGFCS*         FCS;
 110   FGAircraft*    Aircraft;
 111   FGTranslation* Translation;
 112   FGRotation*    Rotation;
 113   FGPosition*    Position;
 114   FGAuxiliary*   Auxiliary;
 115   FGOutput*      Output;
 116
 117   bool Allocate(void);
 118   bool DeAllocate(void);
 119
 120 protected:
 121 };
 122
 123 /******************************************************************************/
 124 #endif