src/FDM/JSBSim/input_output/net_fdm.hxx

   1 // net_fdm.hxx -- defines a common net I/O interface to the flight
   2 //                dynamics model
   3 //
   4 // Written by Curtis Olson - http://www.flightgear.org/~curt
   5 // Started September 2001.
   6 //
   7 // This file is in the Public Domain, and comes with no warranty.
   8 //
   9 // $Id$
  10
  11
  12 #ifndef _NET_FDM_HXX
  13 #define _NET_FDM_HXX
  14
  15
  16 #include <time.h> // time_t
  17
  18 #ifdef _MSC_VER
  19 typedef unsigned long uint32_t;
  20 typedef long int32_t;
  21 #endif
  22
  23 //--->>>#include <simgear/misc/stdint.hxx> //not required for JSBSim
  24
  25
  26 // NOTE: this file defines an external interface structure.  Due to
  27 // variability between platforms and architectures, we only used fixed
  28 // length types here.  Specifically, integer types can vary in length.
  29 // I am not aware of any platforms that don't use 4 bytes for float
  30 // and 8 bytes for double.
  31
  32 const uint32_t FG_NET_FDM_VERSION = 24;
  33
  34
  35 // Define a structure containing the top level flight dynamics model
  36 // parameters
  37
  38 class FGNetFDM {
  39
  40 public:
  41
  42     enum {
  43         FG_MAX_ENGINES = 4,
  44         FG_MAX_WHEELS = 3,
  45         FG_MAX_TANKS = 4
  46     };
  47
  48     uint32_t version;           // increment when data values change
  49     uint32_t padding;           // padding
  50
  51     // Positions
  52     double longitude;           // geodetic (radians)
  53     double latitude;            // geodetic (radians)
  54     double altitude;            // above sea level (meters)
  55     float agl;                  // above ground level (meters)
  56     float phi;                  // roll (radians)
  57     float theta;                // pitch (radians)
  58     float psi;                  // yaw or true heading (radians)
  59     float alpha;                // angle of attack (radians)
  60     float beta;                 // side slip angle (radians)
  61
  62     // Velocities
  63     float phidot;               // roll rate (radians/sec)
  64     float thetadot;             // pitch rate (radians/sec)
  65     float psidot;               // yaw rate (radians/sec)
  66     float vcas;                 // calibrated airspeed
  67     float climb_rate;           // feet per second
  68     float v_north;              // north velocity in local/body frame, fps
  69     float v_east;               // east velocity in local/body frame, fps
  70     float v_down;               // down/vertical velocity in local/body frame, fps
  71     float v_wind_body_north;    // north velocity in local/body frame
  72                                 // relative to local airmass, fps
  73     float v_wind_body_east;     // east velocity in local/body frame
  74                                 // relative to local airmass, fps
  75     float v_wind_body_down;     // down/vertical velocity in local/body
  76                                 // frame relative to local airmass, fps
  77
  78     // Accelerations
  79     float A_X_pilot;            // X accel in body frame ft/sec^2
  80     float A_Y_pilot;            // Y accel in body frame ft/sec^2
  81     float A_Z_pilot;            // Z accel in body frame ft/sec^2
  82
  83     // Stall
  84     float stall_warning;        // 0.0 - 1.0 indicating the amount of stall
  85     float slip_deg;             // slip ball deflection
  86
  87     // Pressure
  88
  89     // Engine status
  90     uint32_t num_engines;            // Number of valid engines
  91     uint32_t eng_state[FG_MAX_ENGINES];// Engine state (off, cranking, running)
  92     float rpm[FG_MAX_ENGINES];       // Engine RPM rev/min
  93     float fuel_flow[FG_MAX_ENGINES]; // Fuel flow gallons/hr
  94     float fuel_px[FG_MAX_ENGINES];   // Fuel pressure psi
  95     float egt[FG_MAX_ENGINES];       // Exhuast gas temp deg F
  96     float cht[FG_MAX_ENGINES];       // Cylinder head temp deg F
  97     float mp_osi[FG_MAX_ENGINES];    // Manifold pressure
  98     float tit[FG_MAX_ENGINES];       // Turbine Inlet Temperature
  99     float oil_temp[FG_MAX_ENGINES];  // Oil temp deg F
 100     float oil_px[FG_MAX_ENGINES];    // Oil pressure psi
 101
 102     // Consumables
 103     uint32_t num_tanks;         // Max number of fuel tanks
 104     float fuel_quantity[FG_MAX_TANKS];
 105
 106     // Gear status
 107     uint32_t num_wheels;
 108     uint32_t wow[FG_MAX_WHEELS];
 109     float gear_pos[FG_MAX_WHEELS];
 110     float gear_steer[FG_MAX_WHEELS];
 111     float gear_compression[FG_MAX_WHEELS];
 112
 113     // Environment
 114     uint32_t cur_time;           // current unix time
 115                                  // FIXME: make this uint64_t before 2038
 116     int32_t warp;                // offset in seconds to unix time
 117     float visibility;            // visibility in meters (for env. effects)
 118
 119     // Control surface positions (normalized values)
 120     float elevator;
 121     float elevator_trim_tab;
 122     float left_flap;
 123     float right_flap;
 124     float left_aileron;
 125     float right_aileron;
 126     float rudder;
 127     float nose_wheel;
 128     float speedbrake;
 129     float spoilers;
 130 };
 131
 132
 133 #endif // _NET_FDM_HXX