src/Network/native_fdm.cxx

   1 // native_fdm.cxx -- FGFS "Native" flight dynamics protocal class
   2 //
   3 // Written by Curtis Olson, started September 2001.
   4 //
   5 // Copyright (C) 2001  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 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <simgear/debug/logstream.hxx>
  29 #include <simgear/io/lowlevel.hxx> // endian tests
  30 #include <simgear/io/iochannel.hxx>
  31 #include <simgear/timing/sg_time.hxx>
  32
  33 #include <FDM/flight.hxx>
  34 #include <Time/tmp.hxx>
  35 #include <Main/fg_props.hxx>
  36 #include <Main/globals.hxx>
  37
  38 #include "native_fdm.hxx"
  39
  40 // FreeBSD works better with this included last ... (?)
  41 #if defined(WIN32) && !defined(__CYGWIN__)
  42 #  include <windows.h>
  43 #else
  44 #  include <netinet/in.h>       // htonl() ntohl()
  45 #endif
  46
  47
  48 // The function htond is defined this way due to the way some
  49 // processors and OSes treat floating point values.  Some will raise
  50 // an exception whenever a "bad" floating point value is loaded into a
  51 // floating point register.  Solaris is notorious for this, but then
  52 // so is LynxOS on the PowerPC.  By translating the data in place,
  53 // there is no need to load a FP register with the "corruped" floating
  54 // point value.  By doing the BIG_ENDIAN test, I can optimize the
  55 // routine for big-endian processors so it can be as efficient as
  56 // possible
  57 static void htond (double &x)
  58 {
  59     if ( sgIsLittleEndian() ) {
  60         int    *Double_Overlay;
  61         int     Holding_Buffer;
  62
  63         Double_Overlay = (int *) &x;
  64         Holding_Buffer = Double_Overlay [0];
  65
  66         Double_Overlay [0] = htonl (Double_Overlay [1]);
  67         Double_Overlay [1] = htonl (Holding_Buffer);
  68     } else {
  69         return;
  70     }
  71 }
  72
  73
  74 FGNativeFDM::FGNativeFDM() {
  75 }
  76
  77 FGNativeFDM::~FGNativeFDM() {
  78 }
  79
  80
  81 // open hailing frequencies
  82 bool FGNativeFDM::open() {
  83     if ( is_enabled() ) {
  84         SG_LOG( SG_IO, SG_ALERT, "This shouldn't happen, but the channel "
  85                 << "is already in use, ignoring" );
  86         return false;
  87     }
  88
  89     SGIOChannel *io = get_io_channel();
  90
  91     if ( ! io->open( get_direction() ) ) {
  92         SG_LOG( SG_IO, SG_ALERT, "Error opening channel communication layer." );
  93         return false;
  94     }
  95
  96     set_enabled( true );
  97
  98     cur_fdm_state->_set_Sea_level_radius( SG_EQUATORIAL_RADIUS_FT );
  99     return true;
 100 }
 101
 102
 103 static void global2net( const FGInterface *global, FGNetFDM *net ) {
 104     static const SGPropertyNode *visibility
 105         = fgGetNode("/environment/visibility-m");
 106
 107     net->version = FG_NET_FDM_VERSION;
 108
 109     // positions
 110     net->longitude = cur_fdm_state->get_Longitude();
 111     net->latitude = cur_fdm_state->get_Latitude();
 112     net->altitude = cur_fdm_state->get_Altitude() * SG_FEET_TO_METER;
 113     net->phi = cur_fdm_state->get_Phi();
 114     net->theta = cur_fdm_state->get_Theta();
 115     net->psi = cur_fdm_state->get_Psi();
 116
 117     // velocities
 118     net->vcas = cur_fdm_state->get_V_calibrated_kts();
 119     net->climb_rate = cur_fdm_state->get_Climb_Rate();
 120
 121     // environment
 122     net->cur_time = globals->get_time_params()->get_cur_time();
 123     net->warp = globals->get_warp();
 124     net->visibility = visibility->getDoubleValue();
 125
 126     // Convert the net buffer to network format
 127     net->version = htonl(net->version);
 128     htond(net->longitude);
 129     htond(net->latitude);
 130     htond(net->altitude);
 131     htond(net->phi);
 132     htond(net->theta);
 133     htond(net->psi);
 134     htond(net->vcas);
 135     htond(net->climb_rate);
 136     net->cur_time = htonl( net->cur_time );
 137     net->warp = htonl( net->warp );
 138     htond(net->visibility);
 139 }
 140
 141
 142 static void net2global( FGNetFDM *net, FGInterface *global ) {
 143     static long int last_warp = 0;
 144
 145     // Convert to the net buffer from network format
 146     net->version = ntohl(net->version);
 147     htond(net->longitude);
 148     htond(net->latitude);
 149     htond(net->altitude);
 150     htond(net->phi);
 151     htond(net->theta);
 152     htond(net->psi);
 153     htond(net->vcas);
 154     htond(net->climb_rate);
 155     net->cur_time = ntohl(net->cur_time);
 156     net->warp = ntohl(net->warp);
 157     htond(net->visibility);
 158
 159     if ( net->version == FG_NET_FDM_VERSION ) {
 160         // cout << "pos = " << net->longitude << " " << net->latitude << endl;
 161         // cout << "sea level rad = " << cur_fdm_state->get_Sea_level_radius() << endl;
 162         cur_fdm_state->_updateGeodeticPosition( net->latitude,
 163                                                 net->longitude,
 164                                                 net->altitude
 165                                                   * SG_METER_TO_FEET );
 166         cur_fdm_state->_set_Euler_Angles( net->phi,
 167                                           net->theta,
 168                                           net->psi );
 169         cur_fdm_state->_set_V_calibrated_kts( net->vcas );
 170         cur_fdm_state->_set_Climb_Rate( net->climb_rate );
 171
 172         if ( net->cur_time ) {
 173             fgSetLong("/sim/time/cur-time-override", net->cur_time);
 174         }
 175
 176         globals->set_warp( net->warp );
 177         if ( net->warp != last_warp ) {
 178             fgUpdateSkyAndLightingParams();
 179         }
 180         last_warp = net->warp;
 181
 182         fgSetDouble( "/environment/visibility-m", net->visibility );
 183     } else {
 184         SG_LOG( SG_IO, SG_ALERT, "Error: version mismatch in net2global()" );
 185         SG_LOG( SG_IO, SG_ALERT,
 186                 "\tread " << net->version << " need " << FG_NET_FDM_VERSION );
 187         SG_LOG( SG_IO, SG_ALERT,
 188                 "\tsomeone needs to upgrade net_fdm.hxx and recompile." );
 189     }
 190 }
 191
 192
 193 // process work for this port
 194 bool FGNativeFDM::process() {
 195     SGIOChannel *io = get_io_channel();
 196     int length = sizeof(buf);
 197
 198     if ( get_direction() == SG_IO_OUT ) {
 199         // cout << "size of cur_fdm_state = " << length << endl;
 200         global2net( cur_fdm_state, &buf );
 201         if ( ! io->write( (char *)(& buf), length ) ) {
 202             SG_LOG( SG_IO, SG_ALERT, "Error writing data." );
 203             return false;
 204         }
 205     } else if ( get_direction() == SG_IO_IN ) {
 206         if ( io->get_type() == sgFileType ) {
 207             if ( io->read( (char *)(& buf), length ) == length ) {
 208                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 209                 net2global( &buf, cur_fdm_state );
 210             }
 211         } else {
 212             while ( io->read( (char *)(& buf), length ) == length ) {
 213                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
 214                 net2global( &buf, cur_fdm_state );
 215             }
 216         }
 217     }
 218
 219     return true;
 220 }
 221
 222
 223 // close the channel
 224 bool FGNativeFDM::close() {
 225     SGIOChannel *io = get_io_channel();
 226
 227     set_enabled( false );
 228
 229     if ( ! io->close() ) {
 230         return false;
 231     }
 232
 233     return true;
 234 }