src/FDM/JSBSim/JSBSim.hxx

   1 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3  Header:        JSBSim.hxx
   4  Author:        Curtis L. Olson
   5  Maintained by: Tony Peden, Curt Olson
   6  Date started:  02/01/1999
   7
   8 ------ Copyright (C) 1999 - 2000  Curtis L. Olson (curt@flightgear.org) ------
   9
  10  This program is free software; you can redistribute it and/or
  11  modify it under the terms of the GNU General Public License as
  12  published by the Free Software Foundation; either version 2 of the
  13  License, or (at your option) any later version.
  14
  15  This program is distributed in the hope that it will be useful, but
  16  WITHOUT ANY WARRANTY; without even the implied warranty of
  17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  General Public License for more details.
  19
  20  You should have received a copy of the GNU General Public License
  21  along with this program; if not, write to the Free Software
  22  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23
  24 HISTORY
  25 --------------------------------------------------------------------------------
  26 02/01/1999   CLO   Created
  27 Additional log messages stored in CVS
  28
  29 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  30 SENTRY
  31 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  32
  33 #ifndef _JSBSIM_HXX
  34 #define _JSBSIM_HXX
  35
  36 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  37 INCLUDES
  38 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  39
  40 #undef MAX_ENGINES
  41 #include <Aircraft/aircraft.hxx>
  42 #include "math/FGColumnVector3.h"
  43
  44 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  45 DEFINITIONS
  46 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  47
  48 #define ID_JSBSIMXX "$Header JSBSim.hxx,v 1.4 2000/10/22 14:02:16 jsb Exp $"
  49
  50 #define METERS_TO_FEET 3.2808398950
  51 #define RADTODEG 57.2957795
  52
  53 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  54 FORWARD DECLARATIONS
  55 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  56
  57 #include <simgear/props/props.hxx>
  58
  59 #include <FDM/JSBSim/FGFDMExec.h>
  60
  61 namespace JSBSim {
  62 class FGState;
  63 class FGAtmosphere;
  64 class FGFCS;
  65 class FGPropulsion;
  66 class FGMassBalance;
  67 class FGAerodynamics;
  68 class FGInertial;
  69 class FGAircraft;
  70 class FGPropagate;
  71 class FGAuxiliary;
  72 class FGOutput;
  73 class FGInitialCondition;
  74 }
  75
  76 // Adding it here will cause a namespace clash in FlightGear -EMH-
  77 // using namespace JSBSim;
  78
  79 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  80 CLASS DOCUMENTATION
  81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  82
  83 /** FGFS / JSBSim interface (aka "The Bus").
  84     This class provides for an interface between FlightGear and its data
  85     structures and JSBSim and its data structures. This is the class which is
  86     used to command JSBSim when integrated with FlightGear. See the
  87     documentation for main for direction on running JSBSim apart from FlightGear.
  88     @author Curtis L. Olson (original)
  89     @author Tony Peden (Maintained and refined)
  90     @version $Id$
  91     @see main in file JSBSim.cpp (use main() wrapper for standalone usage)
  92 */
  93
  94 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  95 CLASS DECLARATION
  96 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
  97
  98 class FGJSBsim: public FGInterface {
  99
 100 public:
 101     /// Constructor
 102     FGJSBsim( double dt );
 103     /// Destructor
 104     ~FGJSBsim();
 105
 106     /// copy FDM state to LaRCsim structures
 107     bool copy_to_JSBsim();
 108
 109     /// copy FDM state from LaRCsim structures
 110     bool copy_from_JSBsim();
 111
 112     /// Reset flight params to a specific position
 113     void init();
 114
 115     /// @name Position Parameter Set
 116     //@{
 117     /** Set geocentric latitude
 118         @param lat latitude in radians measured from the 0 meridian where
 119                    the westerly direction is positive and east is negative */
 120     void set_Latitude(double lat);  // geocentric
 121
 122     /** Set longitude
 123         @param lon longitude in radians measured from the equator where
 124                    the northerly direction is positive and south is negative */
 125     void set_Longitude(double lon);
 126
 127     /** Set altitude
 128         Note: this triggers a recalculation of AGL altitude
 129         @param alt altitude in feet */
 130     void set_Altitude(double alt);        // triggers re-calc of AGL altitude
 131     //@}
 132
 133     //void set_AltitudeAGL(double altagl); // and vice-versa
 134
 135     /// @name Velocity Parameter Set
 136     //@{
 137     /** Sets calibrated airspeed
 138         Setting this will trigger a recalc of the other velocity terms.
 139         @param vc Calibrated airspeed in ft/sec */
 140     void set_V_calibrated_kts(double vc);
 141
 142     /** Sets Mach number.
 143         Setting this will trigger a recalc of the other velocity terms.
 144         @param mach Mach number */
 145     void set_Mach_number(double mach);
 146
 147     /** Sets velocity in N-E-D coordinates.
 148         Setting this will trigger a recalc of the other velocity terms.
 149         @param north velocity northward in ft/sec
 150         @param east velocity eastward in ft/sec
 151         @param down velocity downward in ft/sec */
 152     void set_Velocities_Local( double north, double east, double down );
 153
 154     /** Sets aircraft velocity in stability frame.
 155         Setting this will trigger a recalc of the other velocity terms.
 156         @param u X velocity in ft/sec
 157         @param v Y velocity  in ft/sec
 158         @param w Z velocity in ft/sec */
 159     void set_Velocities_Wind_Body( double u, double v, double w);
 160     //@}
 161
 162     /** Euler Angle Parameter Set
 163         @param phi roll angle in radians
 164         @param theta pitch angle in radians
 165         @param psi heading angle in radians */
 166     void set_Euler_Angles( double phi, double theta, double psi );
 167
 168     /// @name Flight Path Parameter Set
 169     //@{
 170     /** Sets rate of climb
 171         @param roc Rate of climb in ft/sec */
 172     void set_Climb_Rate( double roc);
 173
 174     /** Sets the flight path angle in radians
 175         @param gamma flight path angle in radians. */
 176     void set_Gamma_vert_rad( double gamma);
 177     //@}
 178
 179
 180     /// @name Atmospheric Parameter Set
 181     //@{
 182     /** Sets the atmospheric static pressure
 183         @param p pressure in psf */
 184 //     void set_Static_pressure(double p);
 185
 186     /** Sets the atmospheric temperature
 187         @param T temperature in degrees rankine */
 188 //     void set_Static_temperature(double T);
 189
 190     /** Sets the atmospheric density.
 191         @param rho air density slugs/cubic foot */
 192 //     void set_Density(double rho);
 193
 194     /** Sets the velocity of the local airmass for wind modeling.
 195         @param wnorth velocity north in fps
 196         @param weast velocity east in fps
 197         @param wdown velocity down in fps*/
 198     /// @name Position Parameter Update
 199     //@{
 200
 201
 202     /** Update the position based on inputs, positions, velocities, etc.
 203         @param dt delta time in seconds. */
 204     void update(double dt);
 205     bool ToggleDataLogging(bool state);
 206     bool ToggleDataLogging(void);
 207     void do_trim(void);
 208     void update_ic(void);
 209
 210     bool get_agl_ft(double t, const double pt[3], double alt_off,
 211                     double contact[3], double normal[3], double vel[3],
 212                     double *agl);
 213 private:
 214     JSBSim::FGFDMExec *fdmex;
 215     JSBSim::FGInitialCondition *fgic;
 216     bool needTrim;
 217
 218     JSBSim::FGState*        State;
 219     JSBSim::FGAtmosphere*   Atmosphere;
 220     JSBSim::FGFCS*          FCS;
 221     JSBSim::FGPropulsion*   Propulsion;
 222     JSBSim::FGMassBalance*  MassBalance;
 223     JSBSim::FGAircraft*     Aircraft;
 224     JSBSim::FGPropagate*    Propagate;
 225     JSBSim::FGAuxiliary*    Auxiliary;
 226     JSBSim::FGAerodynamics* Aerodynamics;
 227     JSBSim::FGGroundReactions* GroundReactions;
 228     JSBSim::FGInertial*     Inertial;
 229
 230     int runcount;
 231     double trim_elev;
 232     double trim_throttle;
 233
 234     SGPropertyNode_ptr startup_trim;
 235     SGPropertyNode_ptr trimmed;
 236     SGPropertyNode_ptr pitch_trim;
 237     SGPropertyNode_ptr throttle_trim;
 238     SGPropertyNode_ptr aileron_trim;
 239     SGPropertyNode_ptr rudder_trim;
 240     SGPropertyNode_ptr stall_warning;
 241
 242     /* SGPropertyNode_ptr elevator_pos_deg;
 243     SGPropertyNode_ptr left_aileron_pos_deg;
 244     SGPropertyNode_ptr right_aileron_pos_deg;
 245     SGPropertyNode_ptr rudder_pos_deg;
 246     SGPropertyNode_ptr flap_pos_deg; */
 247
 248
 249     SGPropertyNode_ptr elevator_pos_pct;
 250     SGPropertyNode_ptr left_aileron_pos_pct;
 251     SGPropertyNode_ptr right_aileron_pos_pct;
 252     SGPropertyNode_ptr rudder_pos_pct;
 253     SGPropertyNode_ptr flap_pos_pct;
 254     SGPropertyNode_ptr speedbrake_pos_pct;
 255     SGPropertyNode_ptr spoilers_pos_pct;
 256
 257     SGPropertyNode_ptr ab_brake_engaged;
 258     SGPropertyNode_ptr ab_brake_left_pct;
 259     SGPropertyNode_ptr ab_brake_right_pct;
 260
 261     SGPropertyNode_ptr gear_pos_pct;
 262     SGPropertyNode_ptr wing_fold_pos_pct;
 263     SGPropertyNode_ptr tailhook_pos_pct;
 264
 265     SGPropertyNode_ptr temperature;
 266     SGPropertyNode_ptr pressure;
 267     SGPropertyNode_ptr density;
 268     SGPropertyNode_ptr turbulence_gain;
 269     SGPropertyNode_ptr turbulence_rate;
 270
 271     SGPropertyNode_ptr wind_from_north;
 272     SGPropertyNode_ptr wind_from_east;
 273     SGPropertyNode_ptr wind_from_down;
 274
 275     SGPropertyNode_ptr slaved;
 276
 277     double last_hook_tip[3];
 278     double last_hook_root[3];
 279     JSBSim::FGColumnVector3 hook_root_struct;
 280     double hook_length;
 281     bool got_wire;
 282
 283     bool crashed;
 284
 285     void init_gear(void);
 286     void update_gear(void);
 287
 288     void update_external_forces(double t_off);
 289
 290 };
 291
 292
 293 #endif // _JSBSIM_HXX
 294
 295