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
 119
 120 void
 121 FGMarkerBeacon::bind ()
 122 {
 123     string branch;
 124     branch = "/instrumentation/" + name;
 125
 126     fgTie((branch + "/inner").c_str(), this,
 127           &FGMarkerBeacon::get_inner_blink);
 128
 129     fgTie((branch + "/middle").c_str(), this,
 130           &FGMarkerBeacon::get_middle_blink);
 131
 132     fgTie((branch + "/outer").c_str(), this,
 133           &FGMarkerBeacon::get_outer_blink);
 134 }
 135
 136
 137 void
 138 FGMarkerBeacon::unbind ()
 139 {
 140     string branch;
 141     branch = "/instrumentation/" + name;
 142
 143     fgUntie((branch + "/inner").c_str());
 144     fgUntie((branch + "/middle").c_str());
 145     fgUntie((branch + "/outer").c_str());
 146 }
 147
 148
 149 // Update the various nav values based on position and valid tuned in navs
 150 void
 151 FGMarkerBeacon::update(double dt)
 152 {
 153     need_update = false;
 154
 155     if ( has_power() && serviceable->getBoolValue()
 156             && !sound_pause->getBoolValue()) {
 157
 158         // On timeout, scan again
 159         _time_before_search_sec -= dt;
 160         if ( _time_before_search_sec < 0 ) {
 161             search();
 162         }
 163         // marker beacon blinking
 164         bool light_on = ( outer_blink || middle_blink || inner_blink );
 165         SGTimeStamp current;
 166         current.stamp();
 167
 168         if ( light_on && (current - blink > 400000) ) {
 169             light_on = false;
 170             blink.stamp();
 171         } else if ( !light_on && (current - blink > 100000) ) {
 172             light_on = true;
 173             blink.stamp();
 174         }
 175
 176         if ( outer_marker ) {
 177             outer_blink = light_on;
 178         } else {
 179             outer_blink = false;
 180         }
 181
 182         if ( middle_marker ) {
 183             middle_blink = light_on;
 184         } else {
 185             middle_blink = false;
 186         }
 187
 188         if ( inner_marker ) {
 189             inner_blink = light_on;
 190         } else {
 191             inner_blink = false;
 192         }
 193
 194         // cout << outer_blink << " " << middle_blink << " "
 195         //      << inner_blink << endl;
 196     } else {
 197         inner_blink = middle_blink = outer_blink = false;
 198     }
 199 }
 200
 201
 202 static bool check_beacon_range( double lon_rad, double lat_rad, double elev_m,
 203                                 FGNavRecord *b )
 204 {
 205     Point3D aircraft = sgGeodToCart( Point3D(lon_rad, lat_rad, elev_m) );
 206     Point3D station = Point3D( b->get_x(), b->get_y(), b->get_z() );
 207     // cout << "    aircraft = " << aircraft << " station = " << station
 208     //      << endl;
 209
 210     double d = aircraft.distance3Dsquared( station ); // meters^2
 211     // cout << "  distance = " << d << " ("
 212     //      << FG_ILS_DEFAULT_RANGE * SG_NM_TO_METER
 213     //         * FG_ILS_DEFAULT_RANGE * SG_NM_TO_METER
 214     //      << ")" << endl;
 215
 216     // cout << "  range = " << sqrt(d) << endl;
 217
 218     // cout << "elev = " << elev * SG_METER_TO_FEET
 219     //      << " current->get_elev() = " << current->get_elev() << endl;
 220     double elev_ft = elev_m * SG_METER_TO_FEET;
 221     double delev = elev_ft - b->get_elev_ft();
 222
 223     // max range is the area under r = 2.4 * alt or r^2 = 4000^2 - alt^2
 224     // whichever is smaller.  The intersection point is 1538 ...
 225     double maxrange2;   // feet^2
 226     if ( delev < 1538.0 ) {
 227         maxrange2 = 2.4 * 2.4 * delev * delev;
 228     } else if ( delev < 4000.0 ) {
 229         maxrange2 = 4000 * 4000 - delev * delev;
 230     } else {
 231         maxrange2 = 0.0;
 232     }
 233     maxrange2 *= SG_FEET_TO_METER * SG_FEET_TO_METER; // convert to meter^2
 234     // cout << "delev = " << delev << " maxrange = " << maxrange << endl;
 235
 236     // match up to twice the published range so we can model
 237     // reduced signal strength
 238     if ( d < maxrange2 ) {
 239         return true;
 240     } else {
 241         return false;
 242     }
 243 }
 244
 245 // Update current nav/adf radio stations based on current postition
 246 void FGMarkerBeacon::search()
 247 {
 248
 249     // reset search time
 250     _time_before_search_sec = 1.0;
 251
 252     static fgMkrBeacType last_beacon = NOBEACON;
 253
 254     double lon_rad = lon_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 255     double lat_rad = lat_node->getDoubleValue() * SGD_DEGREES_TO_RADIANS;
 256     double elev_m = alt_node->getDoubleValue() * SG_FEET_TO_METER;
 257
 258     ////////////////////////////////////////////////////////////////////////
 259     // Beacons.
 260     ////////////////////////////////////////////////////////////////////////
 261
 262     // get closest marker beacon
 263     FGNavRecord *b
 264         = globals->get_mkrlist()->findClosest( lon_rad, lat_rad, elev_m );
 265
 266     // cout << "marker beacon = " << b << " (" << b->get_type() << ")" << endl;
 267
 268     fgMkrBeacType beacon_type = NOBEACON;
 269     bool inrange = false;
 270     if ( b != NULL ) {
 271         if ( b->get_type() == 7 ) {
 272             beacon_type = OUTER;
 273         } else if ( b->get_type() == 8 ) {
 274             beacon_type = MIDDLE;
 275         } else if ( b->get_type() == 9 ) {
 276             beacon_type = INNER;
 277         }
 278         inrange = check_beacon_range( lon_rad, lat_rad, elev_m, b );
 279         // cout << "  inrange = " << inrange << endl;
 280     }
 281
 282     outer_marker = middle_marker = inner_marker = false;
 283
 284     if ( b == NULL || !inrange || !has_power() || !serviceable->getBoolValue() )
 285     {
 286         // cout << "no marker" << endl;
 287         globals->get_soundmgr()->stop( "outer-marker" );
 288         globals->get_soundmgr()->stop( "middle-marker" );
 289         globals->get_soundmgr()->stop( "inner-marker" );
 290     } else if ( beacon_type == OUTER ) {
 291         outer_marker = true;
 292         // cout << "OUTER MARKER" << endl;
 293         if ( last_beacon != OUTER ) {
 294             if ( ! globals->get_soundmgr()->exists( "outer-marker" ) ) {
 295                 SGSoundSample *sound = beacon.get_outer();
 296                 if ( sound ) {
 297                     sound->set_volume( 0.3 );
 298                     globals->get_soundmgr()->add( sound, "outer-marker" );
 299                 }
 300             }
 301         }
 302         if ( audio_btn->getBoolValue() ) {
 303             if ( !globals->get_soundmgr()->is_playing("outer-marker") ) {
 304                 globals->get_soundmgr()->play_looped( "outer-marker" );
 305             }
 306         } else {
 307             globals->get_soundmgr()->stop( "outer-marker" );
 308         }
 309     } else if ( beacon_type == MIDDLE ) {
 310         middle_marker = true;
 311         // cout << "MIDDLE MARKER" << endl;
 312         if ( last_beacon != MIDDLE ) {
 313             if ( ! globals->get_soundmgr()->exists( "middle-marker" ) ) {
 314                 SGSoundSample *sound = beacon.get_middle();
 315                 if ( sound ) {
 316                     sound->set_volume( 0.3 );
 317                     globals->get_soundmgr()->add( sound, "middle-marker" );
 318                 }
 319             }
 320         }
 321         if ( audio_btn->getBoolValue() ) {
 322             if ( !globals->get_soundmgr()->is_playing("middle-marker") ) {
 323                 globals->get_soundmgr()->play_looped( "middle-marker" );
 324             }
 325         } else {
 326             globals->get_soundmgr()->stop( "middle-marker" );
 327         }
 328     } else if ( beacon_type == INNER ) {
 329         inner_marker = true;
 330         // cout << "INNER MARKER" << endl;
 331         if ( last_beacon != INNER ) {
 332             if ( ! globals->get_soundmgr()->exists( "inner-marker" ) ) {
 333                 SGSoundSample *sound = beacon.get_inner();
 334                 if ( sound ) {
 335                     sound->set_volume( 0.3 );
 336                     globals->get_soundmgr()->add( sound, "inner-marker" );
 337                 }
 338             }
 339         }
 340         if ( audio_btn->getBoolValue() ) {
 341             if ( !globals->get_soundmgr()->is_playing("inner-marker") ) {
 342                 globals->get_soundmgr()->play_looped( "inner-marker" );
 343             }
 344         } else {
 345             globals->get_soundmgr()->stop( "inner-marker" );
 346         }
 347     }
 348
 349     if ( inrange ) {
 350         last_beacon = beacon_type;
 351     } else {
 352         last_beacon = NOBEACON;
 353     }
 354 }