]> git.mxchange.org Git - flightgear.git/blobdiff - src/Network/net_ctrls.hxx
Merge branch 'work4' into next
[flightgear.git] / src / Network / net_ctrls.hxx
index 6bb9461b066b9bc62f954a26e27f01710a14ca41..30eaf01c236ccba9544e05bf84653f74de0f7e09 100644 (file)
 #ifndef _NET_CTRLS_HXX
 #define _NET_CTRLS_HXX
 
+#include <simgear/misc/stdint.hxx>
 
-#ifndef __cplusplus                                                          
-# error This library requires C++
-#endif                                   
+// NOTE: this file defines an external interface structure.  Due to
+// variability between platforms and architectures, we only used fixed
+// length types here.  Specifically, integer types can vary in length.
+// I am not aware of any platforms that don't use 4 bytes for float
+// and 8 bytes for double.
 
-const int FG_NET_CTRLS_VERSION = 24;
+//    !!! IMPORTANT !!!
+/* There is some space reserved in the protocol for future use.
+ * When adding a new type, add it just before the "reserved" definition
+ * and subtract the size of this new type from the RESERVED_SPACE definition
+ * (1 for (u)int32_t or float and 2 for double).
+ *     
+ * This way the protocol will be forward and backward compatible until
+ * RESERVED_SPACE becomes zero.
+ */
+
+#define RESERVED_SPACE 25
+const uint32_t FG_NET_CTRLS_VERSION = 27;
 
 
 // Define a structure containing the control parameters
@@ -26,14 +40,14 @@ class FGNetCtrls {
 
 public:
 
-    int version;                        // increment when data values change
-
     enum {
         FG_MAX_ENGINES = 4,
         FG_MAX_WHEELS = 16,
-        FG_MAX_TANKS = 6
+        FG_MAX_TANKS = 8
     };
 
+    uint32_t version;                   // increment when data values change
+
     // Aero controls
     double aileron;                     // -1 ... 1
     double elevator;                    // -1 ... 1
@@ -42,34 +56,43 @@ public:
     double elevator_trim;               // -1 ... 1
     double rudder_trim;                         // -1 ... 1
     double flaps;                       //  0 ... 1
+    double spoilers;
+    double speedbrake;
 
     // Aero control faults
-    bool flaps_power;                    //  true = power available
-    bool flap_motor_ok;
+    uint32_t flaps_power;                 // true = power available
+    uint32_t flap_motor_ok;
 
     // Engine controls
-    int num_engines;                    // number of valid engines
-    bool master_bat[FG_MAX_ENGINES];
-    bool master_alt[FG_MAX_ENGINES];
-    int magnetos[FG_MAX_ENGINES];
-    bool starter_power[FG_MAX_ENGINES];  // true = starter power
+    uint32_t num_engines;               // number of valid engines
+    uint32_t master_bat[FG_MAX_ENGINES];
+    uint32_t master_alt[FG_MAX_ENGINES];
+    uint32_t magnetos[FG_MAX_ENGINES];
+    uint32_t starter_power[FG_MAX_ENGINES];// true = starter power
     double throttle[FG_MAX_ENGINES];     //  0 ... 1
     double mixture[FG_MAX_ENGINES];      //  0 ... 1
     double condition[FG_MAX_ENGINES];    //  0 ... 1
-    bool fuel_pump_power[FG_MAX_ENGINES];// true = on
+    uint32_t fuel_pump_power[FG_MAX_ENGINES];// true = on
     double prop_advance[FG_MAX_ENGINES]; //  0 ... 1
+    uint32_t feed_tank_to[4];
+    uint32_t reverse[4];
+
 
     // Engine faults
-    bool engine_ok[FG_MAX_ENGINES];
-    bool mag_left_ok[FG_MAX_ENGINES];
-    bool mag_right_ok[FG_MAX_ENGINES];
-    bool spark_plugs_ok[FG_MAX_ENGINES];  // false = fouled plugs
-    int oil_press_status[FG_MAX_ENGINES]; // 0 = normal, 1 = low, 2 = full fail
-    bool fuel_pump_ok[FG_MAX_ENGINES];
+    uint32_t engine_ok[FG_MAX_ENGINES];
+    uint32_t mag_left_ok[FG_MAX_ENGINES];
+    uint32_t mag_right_ok[FG_MAX_ENGINES];
+    uint32_t spark_plugs_ok[FG_MAX_ENGINES];  // false = fouled plugs
+    uint32_t oil_press_status[FG_MAX_ENGINES];// 0 = normal, 1 = low, 2 = full fail
+    uint32_t fuel_pump_ok[FG_MAX_ENGINES];
 
     // Fuel management
-    int num_tanks;                       // number of valid tanks
-    bool fuel_selector[FG_MAX_TANKS];    // false = off, true = on
+    uint32_t num_tanks;                      // number of valid tanks
+    uint32_t fuel_selector[FG_MAX_TANKS];    // false = off, true = on
+    uint32_t xfer_pump[5];                   // specifies transfer from array
+                                             // value tank to tank specified by
+                                             // int value
+    uint32_t cross_feed;                     // false = off, true = on
 
     // Brake controls
     double brake_left;
@@ -79,10 +102,16 @@ public:
     double brake_parking;
     
     // Landing Gear
-    bool gear_handle; // true=gear handle down; false= gear handle up
+    uint32_t gear_handle; // true=gear handle down; false= gear handle up
 
     // Switches
-    bool master_avionics;
+    uint32_t master_avionics;
+    
+        // nav and Comm
+    double     comm_1;
+    double     comm_2;
+    double     nav_1;
+    double     nav_2;
 
     // wind and turbulance
     double wind_speed_kt;
@@ -98,16 +127,22 @@ public:
     double magvar;                      // local magnetic variation in degs.
 
     // hazards
-    bool icing;                          // icing status could me much
+    uint32_t icing;                      // icing status could me much
                                          // more complex but I'm
                                          // starting simple here.
 
     // simulation control
-    int speedup;                        // integer speedup multiplier
-    int freeze;                                 // 0=normal
+    uint32_t speedup;                   // integer speedup multiplier
+    uint32_t freeze;                    // 0=normal
                                         // 0x01=master
                                         // 0x02=position
                                         // 0x04=fuel
+
+    // --- New since FlightGear 0.9.10 (FG_NET_CTRLS_VERSION = 27)
+
+    // --- Add new variables just before this line.
+
+    uint32_t reserved[RESERVED_SPACE];  // 100 bytes reserved for future use.
 };