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