src/Instrumentation/marker_beacon.cxx

   1 // marker_beacon.cxx -- class to manage the marker beacons
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 //
   5 // Copyright (C) 2000  Curtis L. Olson - http://www.flightgear.org/~curt
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include <config.h>
  26 #endif
  27
  28 #include <stdio.h>      // snprintf
  29
  30 #include <simgear/compiler.h>
  31 #include <simgear/math/sg_random.h>
  32
  33 #include <Aircraft/aircraft.hxx>
  34 #include <Navaids/navlist.hxx>
  35
  36 #include "marker_beacon.hxx"
  37
  38 #include <string>
  39 SG_USING_STD(string);
  40
  41
  42 // Constructor
  43 FGMarkerBeacon::FGMarkerBeacon(SGPropertyNode *node) :
  44     need_update(true),
  45     outer_blink(false),
  46     middle_blink(false),
  47     inner_blink(false),
  48     name("marker-beacon"),
  49     num(0),
  50     _time_before_search_sec(0.0)
  51 {
  52     SGPath path( globals->get_fg_root() );
  53     SGPath term = path;
  54     term.append( "Navaids/range.term" );
  55     SGPath low = path;
  56     low.append( "Navaids/range.low" );
  57     SGPath high = path;
  58     high.append( "Navaids/range.high" );
  59
  60     term_tbl = new SGInterpTable( term.str() );
  61     low_tbl = new SGInterpTable( low.str() );
  62     high_tbl = new SGInterpTable( high.str() );
  63
  64     int i;
  65     for ( i = 0; i < node->nChildren(); ++i ) {
  66         SGPropertyNode *child = node->getChild(i);
  67         string cname = child->getName();
  68         string cval = child->getStringValue();
  69         if ( cname == "name" ) {
  70             name = cval;
  71         } else if ( cname == "number" ) {
  72             num = child->getIntValue();
  73         } else {
  74             SG_LOG( SG_INSTR, SG_WARN,
  75                     "Error in marker beacon config logic" );
  76             if ( name.length() ) {
  77                 SG_LOG( SG_INSTR, SG_WARN, "Section = " << name );
  78             }
  79         }
  80     }
  81 }
  82
  83
  84 // Destructor
  85 FGMarkerBeacon::~FGMarkerBeacon()
  86 {
  87     delete term_tbl;
  88     delete low_tbl;
  89     delete high_tbl;
  90 }
  91
  92
  93 void
  94 FGMarkerBeacon::init ()
  95 {
  96     string branch;
  97     branch = "/instrumentation/" + name;
  98
  99     SGPropertyNode *node = fgGetNode(branch.c_str(), num, true );
 100     // Inputs
 101     sound_pause = fgGetNode("/sim/sound/pause", false);
 102     lon_node = fgGetNode("/position/longitude-deg", true);
 103     lat_node = fgGetNode("/position/latitude-deg", true);
 104     alt_node = fgGetNode("/position/altitude-ft", true);
 105     bus_power = fgGetNode("/systems/electrical/outputs/nav[0]", true);
 106     power_btn = node->getChild("power-btn", 0, true);
 107     audio_btn = node->getChild("audio-btn", 0, true);
 108     serviceable = node->getChild("serviceable", 0, true);
 109
 110     power_btn->setBoolValue( true );
 111     audio_btn->setBoolValue( true );
 112     serviceable->setBoolValue( true );
 113
 114     morse.init();
 115     beacon.init();
 116     blink.stamp();
 117
 118     outer_marker = middle_marker = inner_marker = false;
 119 }
 120
 121
 122 void
 123 FGMarkerBeacon::bind ()
 124 {
 125     string branch;
 126     branch = "/instrumentation/" + name;
 127
 128     fgTie((branch + "/inner").c_str(), this,
 129           &FGMarkerBeacon::get_inner_blink);
 130
 131     fgTie((branch + "/middle").c_str(), this,
 132           &FGMarkerBeacon::get_middle_blink);
 133
 134     fgTie((branch + "/outer").c_str(), this,
 135           &FGMarkerBeacon::get_outer_blink);
 136 }
 137
 138
 139 void
 140 FGMarkerBeacon::unbind ()
 141 {
 142     string branch;
 143     branch = "/instrumentation/" + name;
 144
 145     fgUntie((branch + "/inner").c_str());
 146     fgUntie((branch + "/middle").c_str());
 147     fgUntie((branch + "/outer").c_str());
 148 }
 149
 150
 151 // Update the various nav values based on position and valid tuned in navs
 152 void
 153 FGMarkerBeacon::update(double dt)
 154 {
 155     need_update = false;
 156
 157     if ( has_power() && serviceable->getBoolValue()
 158             && !sound_pause->getBoolValue()) {
 159
 160         // On timeout, scan again
 161         _time_before_search_sec -= dt;
 162         if ( _time_before_search_sec < 0 ) {
 163             search();
 164         }
 165         // marker beacon blinking
 166         bool light_on = ( outer_blink || middle_blink || inner_blink );
 167         SGTimeStamp current;
 168         current.stamp();
 169
 170         if ( light_on && (current - blink > 400000) ) {
 171             light_on = false;
 172             blink.stamp();
 173         } else if ( !light_on && (current - blink > 100000) ) {
 174             light_on = true;
 175             blink.stamp();
 176         }
 177
 178         if ( outer_marker ) {
 179             outer_blink = light_on;
 180         } else {
 181             outer_blink = false;
 182         }
 183
 184         if ( middle_marker ) {
 185             middle_blink = light_on;
 186         } else {
 187             middle_blink = false;
 188         }
 189
 190         if ( inner_marker ) {
 191             inner_blink = light_on;
 192         } else {
 193             inner_blink = false;
 194         }
 195
 196         // cout << outer_blink << " " << middle_blink << " "
 197         //      << inner_blink << endl;
 198     } else {
 199         inner_blink = middle_blink = outer_blink = false;
 200     }
 201 }
 202
 203
 204 static bool check_beacon_range( const SGGeod& pos,
 205                                 FGNavRecord *b )
 206 {
 207     SGVec3d aircraft = SGVec3d::fromGeod(pos);
 208     SGVec3d station = b->get_cart();
 209     // cout << "    aircraft = " << aircraft << " station = " << station
 210     //      << endl;
 211
 212     SGVec3d tmp = station - aircraft;
 213     double d = dot(tmp, tmp);
 214     // cout << "  distance = " << d << " ("
 215     //      << FG_ILS_DEFAULT_RANGE * SG_NM_TO_METER
 216     //         * FG_ILS_DEFAULT_RANGE * SG_NM_TO_METER
 217     //      << ")" << endl;
 218
 219     // cout << "  range = " << sqrt(d) << endl;
 220
 221     // cout << "elev = " << elev * SG_METER_TO_FEET
 222     //      << " current->get_elev() = " << current->get_elev() << endl;
 223     double elev_ft = pos.getElevationFt();
 224     double delev = elev_ft - b->get_elev_ft();
 225
 226     // max range is the area under r = 2.4 * alt or r^2 = 4000^2 - alt^2
 227     // whichever is smaller.  The intersection point is 1538 ...
 228     double maxrange2;   // feet^2
 229     if ( delev < 1538.0 ) {
 230         maxrange2 = 2.4 * 2.4 * delev * delev;
 231     } else if ( delev < 4000.0 ) {
 232         maxrange2 = 4000 * 4000 - delev * delev;
 233     } else {
 234         maxrange2 = 0.0;
 235     }
 236     maxrange2 *= SG_FEET_TO_METER * SG_FEET_TO_METER; // convert to meter^2
 237     // cout << "delev = " << delev << " maxrange = " << maxrange << endl;
 238
 239     // match up to twice the published range so we can model
 240     // reduced signal strength
 241     if ( d < maxrange2 ) {
 242         return true;
 243     } else {
 244         return false;
 245     }
 246 }
 247
 248 // Update current nav/adf radio stations based on current postition
 249 void FGMarkerBeacon::search()
 250 {
 251
 252     // reset search time
 253     _time_before_search_sec = 1.0;
 254
 255     static fgMkrBeacType last_beacon = NOBEACON;
 256
 257     SGGeod pos = SGGeod::fromDegFt(lon_node->getDoubleValue(),
 258                                    lat_node->getDoubleValue(),
 259                                    alt_node->getDoubleValue());
 260
 261     ////////////////////////////////////////////////////////////////////////
 262     // Beacons.
 263     ////////////////////////////////////////////////////////////////////////
 264
 265     // get closest marker beacon
 266     FGNavRecord *b
 267       = globals->get_mkrlist()->findClosest( pos.getLongitudeRad(),
 268                                              pos.getLatitudeRad(),
 269                                              pos.getElevationM() );
 270
 271     // cout << "marker beacon = " << b << " (" << b->get_type() << ")" << endl;
 272
 273     fgMkrBeacType beacon_type = NOBEACON;
 274     bool inrange = false;
 275     if ( b != NULL ) {
 276         if ( b->get_type() == 7 ) {
 277             beacon_type = OUTER;
 278         } else if ( b->get_type() == 8 ) {
 279             beacon_type = MIDDLE;
 280         } else if ( b->get_type() == 9 ) {
 281             beacon_type = INNER;
 282         }
 283         inrange = check_beacon_range( pos, b );
 284         // cout << "  inrange = " << inrange << endl;
 285     }
 286
 287     outer_marker = middle_marker = inner_marker = false;
 288
 289     if ( b == NULL || !inrange || !has_power() || !serviceable->getBoolValue() )
 290     {
 291         // cout << "no marker" << endl;
 292         globals->get_soundmgr()->stop( "outer-marker" );
 293         globals->get_soundmgr()->stop( "middle-marker" );
 294         globals->get_soundmgr()->stop( "inner-marker" );
 295     } else if ( beacon_type == OUTER ) {
 296         outer_marker = true;
 297         // cout << "OUTER MARKER" << endl;
 298         if ( last_beacon != OUTER ) {
 299             if ( ! globals->get_soundmgr()->exists( "outer-marker" ) ) {
 300                 SGSoundSample *sound = beacon.get_outer();
 301                 if ( sound ) {
 302                     sound->set_volume( 0.3 );
 303                     globals->get_soundmgr()->add( sound, "outer-marker" );
 304                 }
 305             }
 306         }
 307         if ( audio_btn->getBoolValue() ) {
 308             if ( !globals->get_soundmgr()->is_playing("outer-marker") ) {
 309                 globals->get_soundmgr()->play_looped( "outer-marker" );
 310             }
 311         } else {
 312             globals->get_soundmgr()->stop( "outer-marker" );
 313         }
 314     } else if ( beacon_type == MIDDLE ) {
 315         middle_marker = true;
 316         // cout << "MIDDLE MARKER" << endl;
 317         if ( last_beacon != MIDDLE ) {
 318             if ( ! globals->get_soundmgr()->exists( "middle-marker" ) ) {
 319                 SGSoundSample *sound = beacon.get_middle();
 320                 if ( sound ) {
 321                     sound->set_volume( 0.3 );
 322                     globals->get_soundmgr()->add( sound, "middle-marker" );
 323                 }
 324             }
 325         }
 326         if ( audio_btn->getBoolValue() ) {
 327             if ( !globals->get_soundmgr()->is_playing("middle-marker") ) {
 328                 globals->get_soundmgr()->play_looped( "middle-marker" );
 329             }
 330         } else {
 331             globals->get_soundmgr()->stop( "middle-marker" );
 332         }
 333     } else if ( beacon_type == INNER ) {
 334         inner_marker = true;
 335         // cout << "INNER MARKER" << endl;
 336         if ( last_beacon != INNER ) {
 337             if ( ! globals->get_soundmgr()->exists( "inner-marker" ) ) {
 338                 SGSoundSample *sound = beacon.get_inner();
 339                 if ( sound ) {
 340                     sound->set_volume( 0.3 );
 341                     globals->get_soundmgr()->add( sound, "inner-marker" );
 342                 }
 343             }
 344         }
 345         if ( audio_btn->getBoolValue() ) {
 346             if ( !globals->get_soundmgr()->is_playing("inner-marker") ) {
 347                 globals->get_soundmgr()->play_looped( "inner-marker" );
 348             }
 349         } else {
 350             globals->get_soundmgr()->stop( "inner-marker" );
 351         }
 352     }
 353
 354     if ( inrange ) {
 355         last_beacon = beacon_type;
 356     } else {
 357         last_beacon = NOBEACON;
 358     }
 359 }