]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGModel.h
#include <config.h> where needed for cygwin/gcc-3.2.
[flightgear.git] / 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 "FGJSBBase.h"
42 #include "FGPropertyManager.h"
43
44 #ifdef FGFS
45 #  include <simgear/compiler.h>
46 #  ifdef SG_HAVE_STD_INCLUDES
47 #    include <iostream>
48 #  else
49 #    include <iostream.h>
50 #  endif
51 #else
52 #  if defined(sgi) && !defined(__GNUC__)
53 #    include <iostream.h>
54 #  else
55 #    include <iostream>
56 #  endif
57 #endif
58
59 #include <string>
60
61 #define ID_MODEL "$Id$"
62
63 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
64 DEFINITIONS
65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
66
67 using namespace std;
68
69 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
70 FORWARD DECLARATIONS
71 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
72
73 class FGFDMExec;
74 class FGState;
75 class FGAtmosphere;
76 class FGFCS;
77 class FGPropulsion;
78 class FGMassBalance;
79 class FGAerodynamics;
80 class FGInertial;
81 class FGGroundReactions;
82 class FGAircraft;
83 class FGTranslation;
84 class FGRotation;
85 class FGPosition;
86 class FGAuxiliary;
87 class FGOutput;
88 class FGConfigFile;
89
90 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91 COMMENTS, REFERENCES, and NOTES [use "class documentation" below for API docs]
92 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
93
94 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
95 CLASS DOCUMENTATION
96 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
97
98 /** Base class for all scheduled JSBSim models
99     @author Jon S. Berndt
100     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGModel.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
101          Header File </a>
102     @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGModel.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
103          Source File </a>
104   */
105
106 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
107 CLASS DECLARATION
108 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
109
110 class FGModel : public FGJSBBase
111 {
112 public:
113
114   /// Constructor
115   FGModel(FGFDMExec*);
116   /// Destructor
117   virtual ~FGModel();
118
119   /** Loads this model.
120       @param Config a pointer to the config file instance
121       @return true if model is successfully loaded*/
122   virtual bool Load(FGConfigFile* Config) {return true;}
123  
124   FGModel* NextModel;
125   string Name;
126
127   /** Runs the model; called by the Executive
128       @see JSBSim.cpp documentation
129       @return false if no error */
130   virtual bool Run(void);
131   virtual bool InitModel(void);
132   virtual void SetRate(int tt) {rate = tt;}
133   virtual int  GetRate(void)   {return rate;}
134   
135   void SetPropertyManager(FGPropertyManager *fgpm) { PropertyManager=fgpm;}
136
137 protected:
138   int exe_ctr;
139   int rate;
140   
141   virtual void Debug(int from);
142
143   FGFDMExec*         FDMExec;
144   FGState*           State;
145   FGAtmosphere*      Atmosphere;
146   FGFCS*             FCS;
147   FGPropulsion*      Propulsion;
148   FGMassBalance*     MassBalance;
149   FGAerodynamics*    Aerodynamics;
150   FGInertial*        Inertial;
151   FGGroundReactions* GroundReactions;
152   FGAircraft*        Aircraft;
153   FGTranslation*     Translation;
154   FGRotation*        Rotation;
155   FGPosition*        Position;
156   FGAuxiliary*       Auxiliary;
157   FGOutput*          Output;
158   FGPropertyManager* PropertyManager;
159 };
160
161 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
162 #endif
163