]> git.mxchange.org Git - flightgear.git/blob - src/FDM/JSBSim/FGTrimAxis.h
Restructuring some of the initialization code.
[flightgear.git] / src / FDM / JSBSim / FGTrimAxis.h
1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2  
3  Header:       FGTrimAxis.h
4  Author:       Tony Peden
5  Date started: 7/3/00
6  
7  ------------- Copyright (C) 1999  Anthony K. Peden (apeden@earthlink.net) -------------
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 7/3/00  TP   Created
29  
30 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31 SENTRY
32 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
33
34 #ifndef FGTRIMAXIS_H
35 #define FGTRIMAXIS_H
36
37 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
38 INCLUDES
39 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
40
41 #include <string>
42
43 #include "FGFDMExec.h"
44 #include "FGJSBBase.h"
45 #include "FGInitialCondition.h"
46
47 #define ID_TRIMAXIS "$Id$"
48
49 #define DEFAULT_TOLERANCE 0.001
50
51 const string StateNames[10]=   { "all","udot","vdot","wdot","qdot","pdot","rdot",
52                                 "hmgt","nlf" 
53                               };
54 const string ControlNames[14]= { "Throttle","Sideslip","Angle of Attack",
55                                  "Elevator","Ailerons","Rudder",
56                                  "Altitude AGL", "Pitch Angle",
57                                  "Roll Angle", "Flight Path Angle", 
58                                  "Pitch Trim", "Roll Trim", "Yaw Trim",
59                                  "Heading"
60                                };
61
62 class FGInitialCondition;
63
64 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
65 CLASS DECLARATION
66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
67
68 enum State { tAll,tUdot,tVdot,tWdot,tQdot,tPdot,tRdot,tHmgt,tNlf };
69 enum Control { tThrottle, tBeta, tAlpha, tElevator, tAileron, tRudder, tAltAGL,
70                tTheta, tPhi, tGamma, tPitchTrim, tRollTrim, tYawTrim, tHeading };
71
72 class FGTrimAxis : public FGJSBBase
73 {
74 public:
75   FGTrimAxis(FGFDMExec* fdmex, 
76              FGInitialCondition *ic, 
77              State st,
78              Control ctrl );
79   ~FGTrimAxis();
80
81   void Run(void);
82  
83   double GetState(void) { getState(); return state_value; }
84   //Accels are not settable
85   inline void SetControl(double value ) { control_value=value; }
86   inline double GetControl(void) { return control_value; }
87
88   inline State GetStateType(void) { return state; }
89   inline Control GetControlType(void) { return control; }
90
91   inline string GetStateName(void) { return StateNames[state]; }
92   inline string GetControlName(void) { return ControlNames[control]; }
93
94   inline double GetControlMin(void) { return control_min; }
95   inline double GetControlMax(void) { return control_max; }
96
97   inline void SetControlToMin(void) { control_value=control_min; }
98   inline void SetControlToMax(void) { control_value=control_max; }
99   
100   inline void SetControlLimits(double min, double max) { 
101       control_min=min;
102       control_max=max;
103   }    
104
105   inline void  SetTolerance(double ff) { tolerance=ff;}
106   inline double GetTolerance(void) { return tolerance; }
107
108   inline double GetSolverEps(void) { return solver_eps; }
109   inline void SetSolverEps(double ff) { solver_eps=ff; }
110
111   inline int  GetIterationLimit(void) { return max_iterations; }
112   inline void SetIterationLimit(int ii) { max_iterations=ii; }
113
114   inline int GetStability(void) { return its_to_stable_value; }
115   inline int GetRunCount(void) { return total_stability_iterations; }
116   double GetAvgStability( void );
117   
118   void SetThetaOnGround(double ff);
119   void SetPhiOnGround(double ff);
120   
121   inline void SetStateTarget(float target) { state_target=target; }
122   inline float GetStateTarget(void) { return state_target; }
123   
124   bool initTheta(void);
125   
126   void AxisReport(void);
127   
128   bool InTolerance(void) { getState(); return (fabs(state_value) <= tolerance); }
129
130 private:
131   FGFDMExec *fdmex;
132   FGInitialCondition *fgic;
133
134   State   state;
135   Control control;
136   
137   float state_target;
138   
139   float state_value;
140   float control_value;
141
142   double control_min;
143   double control_max;
144
145   double tolerance;
146
147   double solver_eps;
148
149   double state_convert;
150   double control_convert;
151
152   int max_iterations;
153
154   int its_to_stable_value;
155   int total_stability_iterations;
156   int total_iterations;
157
158   void setThrottlesPct(void);
159
160   void getState(void);
161   void getControl(void);
162   void setControl(void);
163   
164   double computeHmgt(void);
165   
166   void Debug(int from);
167 };
168
169 #endif