src/FDM/JSBSim.hxx

   1 // JSBsim.hxx -- interface to the "JSBsim" flight model
   2 //
   3 // Written by Curtis Olson, started February 1999.
   4 //
   5 // Copyright (C) 1999  Curtis L. Olson  - curt@flightgear.org
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _JSBSIM_HXX
  25 #define _JSBSIM_HXX
  26
  27 #include <FDM/JSBSim/FGFDMExec.h>
  28 #include <FDM/JSBSim/FGInitialCondition.h>
  29 #undef MAX_ENGINES
  30
  31 #include <Aircraft/aircraft.hxx>
  32
  33 #define ID_JSBSIMXX "$Header"
  34
  35 class FGJSBsim: public FGInterface {
  36
  37     // The aircraft for this instance
  38     FGFDMExec *fdmex;
  39     FGInitialCondition *fgic;
  40     bool needTrim;
  41
  42     bool trimmed;
  43     float trim_elev;
  44     float trim_throttle;
  45
  46 public:
  47
  48     FGJSBsim::FGJSBsim(void);
  49     FGJSBsim::~FGJSBsim();
  50
  51     // copy FDM state to LaRCsim structures
  52     bool copy_to_JSBsim();
  53
  54     // copy FDM state from LaRCsim structures
  55     bool copy_from_JSBsim();
  56
  57     // reset flight params to a specific position
  58     bool init( double dt );
  59
  60     // Positions
  61     void set_Latitude(double lat);  // geocentric
  62     void set_Longitude(double lon);
  63     void set_Altitude(double alt);        // triggers re-calc of AGL altitude
  64     //void set_AltitudeAGL(double altagl); // and vice-versa
  65
  66     // Speeds -- setting any of these will trigger a re-calc of the rest
  67     void set_V_calibrated_kts(double vc);
  68     void set_Mach_number(double mach);
  69     void set_Velocities_Local( double north, double east, double down );
  70     void set_Velocities_Wind_Body( double u, double v, double w);
  71
  72     // Euler angles
  73     void set_Euler_Angles( double phi, double theta, double psi );
  74
  75     // Flight Path
  76     void set_Climb_Rate( double roc);
  77     void set_Gamma_vert_rad( double gamma);
  78
  79     // Earth
  80     void set_Sea_level_radius(double slr);
  81     void set_Runway_altitude(double ralt);
  82
  83     // Atmosphere
  84     void set_Static_pressure(double p);
  85     void set_Static_temperature(double T);
  86     void set_Density(double rho);
  87     void set_Velocities_Local_Airmass (double wnorth,
  88                                        double weast,
  89                                        double wdown );
  90
  91     // update position based on inputs, positions, velocities, etc.
  92     bool update( int multiloop );
  93 };
  94
  95
  96 #endif // _JSBSIM_HXX
  97
  98