src/Instrumentation/instrument_mgr.cxx

   1 // instrument_mgr.cxx - manage aircraft instruments.
   2 // Written by David Megginson, started 2002.
   3 //
   4 // This file is in the Public Domain and comes with no warranty.
   5
   6 #ifdef HAVE_CONFIG_H
   7 #  include <config.h>
   8 #endif
   9
  10 #include <iostream>
  11 #include <string>
  12 #include <sstream>
  13
  14 #include <simgear/structure/exception.hxx>
  15 #include <simgear/misc/sg_path.hxx>
  16 #include <simgear/sg_inlines.h>
  17 #include <simgear/props/props_io.hxx>
  18
  19 #include <Main/fg_props.hxx>
  20 #include <Main/globals.hxx>
  21 #include <Main/util.hxx>
  22 #include <Instrumentation/HUD/HUD.hxx>
  23
  24 #include "instrument_mgr.hxx"
  25 #include "adf.hxx"
  26 #include "airspeed_indicator.hxx"
  27 #include "altimeter.hxx"
  28 #include "attitude_indicator.hxx"
  29 #include "clock.hxx"
  30 #include "dme.hxx"
  31 #include "gps.hxx"
  32 #include "gsdi.hxx"
  33 #include "heading_indicator.hxx"
  34 #include "heading_indicator_fg.hxx"
  35 #include "heading_indicator_dg.hxx"
  36 #include "kr_87.hxx"
  37 #include "kt_70.hxx"
  38 #include "mag_compass.hxx"
  39 #include "marker_beacon.hxx"
  40 #include "newnavradio.hxx"
  41 #include "slip_skid_ball.hxx"
  42 #include "transponder.hxx"
  43 #include "turn_indicator.hxx"
  44 #include "vertical_speed_indicator.hxx"
  45 #include "inst_vertical_speed_indicator.hxx"
  46 #include "wxradar.hxx"
  47 #include "tacan.hxx"
  48 #include "mk_viii.hxx"
  49 #include "mrg.hxx"
  50 #include "groundradar.hxx"
  51 #include "agradar.hxx"
  52 #include "rad_alt.hxx"
  53 #include "tcas.hxx"
  54 #include "NavDisplay.hxx"
  55
  56 FGInstrumentMgr::FGInstrumentMgr () :
  57   _explicitGps(false)
  58 {
  59     globals->add_subsystem("hud", new HUD, SGSubsystemMgr::DISPLAY);
  60 }
  61
  62 FGInstrumentMgr::~FGInstrumentMgr ()
  63 {
  64 }
  65
  66 SGSubsystem::InitStatus FGInstrumentMgr::incrementalInit()
  67 {
  68   init();
  69   return INIT_DONE;
  70 }
  71
  72 void FGInstrumentMgr::init()
  73 {
  74   SGPropertyNode_ptr config_props = new SGPropertyNode;
  75   SGPropertyNode* path_n = fgGetNode("/sim/instrumentation/path");
  76   if (!path_n) {
  77     SG_LOG(SG_COCKPIT, SG_WARN, "No instrumentation model specified for this model!");
  78     return;
  79   }
  80
  81   SGPath config = globals->resolve_aircraft_path(path_n->getStringValue());
  82   SG_LOG( SG_COCKPIT, SG_INFO, "Reading instruments from " << config.str() );
  83
  84   try {
  85     readProperties( config.str(), config_props );
  86     if (!build(config_props)) {
  87       throw sg_exception(
  88                     "Detected an internal inconsistency in the instrumentation\n"
  89                     "system specification file.  See earlier errors for details.");
  90     }
  91   } catch (const sg_exception& e) {
  92     SG_LOG(SG_COCKPIT, SG_ALERT, "Failed to load instrumentation system model: "
  93                     << config.str() << ":" << e.getFormattedMessage() );
  94   }
  95
  96
  97   if (!_explicitGps) {
  98     SG_LOG(SG_INSTR, SG_INFO, "creating default GPS instrument");
  99     SGPropertyNode_ptr nd(new SGPropertyNode);
 100     nd->setStringValue("name", "gps");
 101     nd->setIntValue("number", 0);
 102     _instruments.push_back("gps[0]");
 103     set_subsystem("gps[0]", new GPS(nd));
 104   }
 105
 106   // bind() created instruments before init.
 107   for (unsigned int i=0; i<_instruments.size(); ++i) {
 108     const std::string& nm(_instruments[i]);
 109     SGSubsystem* instr = get_subsystem(nm);
 110     instr->bind();
 111   }
 112
 113   SGSubsystemGroup::init();
 114 }
 115
 116 void FGInstrumentMgr::reinit()
 117 {
 118 // delete all our instrument
 119   for (unsigned int i=0; i<_instruments.size(); ++i) {
 120     const std::string& nm(_instruments[i]);
 121     SGSubsystem* instr = get_subsystem(nm);
 122     instr->unbind();
 123     remove_subsystem(nm);
 124     delete instr;
 125   }
 126
 127   init();
 128 }
 129
 130 bool FGInstrumentMgr::build (SGPropertyNode* config_props)
 131 {
 132     for ( int i = 0; i < config_props->nChildren(); ++i ) {
 133         SGPropertyNode *node = config_props->getChild(i);
 134         string name = node->getName();
 135
 136         std::ostringstream subsystemname;
 137         subsystemname << "instrument-" << i << '-'
 138                 << node->getStringValue("name", name.c_str());
 139         int index = node->getIntValue("number", 0);
 140         if (index > 0)
 141             subsystemname << '['<< index << ']';
 142         string id = subsystemname.str();
 143         _instruments.push_back(id);
 144
 145         if ( name == "adf" ) {
 146             set_subsystem( id, new ADF( node ), 0.15 );
 147
 148         } else if ( name == "airspeed-indicator" ) {
 149             set_subsystem( id, new AirspeedIndicator( node ) );
 150
 151         } else if ( name == "altimeter" ) {
 152             set_subsystem( id, new Altimeter( node ) );
 153
 154         } else if ( name == "attitude-indicator" ) {
 155             set_subsystem( id, new AttitudeIndicator( node ) );
 156
 157         } else if ( name == "clock" ) {
 158             set_subsystem( id, new Clock( node ), 0.25 );
 159
 160         } else if ( name == "dme" ) {
 161             set_subsystem( id, new DME( node ), 1.0 );
 162
 163         } else if ( name == "encoder" ) {
 164             set_subsystem( id, new Altimeter( node ), 0.15 );
 165
 166         } else if ( name == "gps" ) {
 167             set_subsystem( id, new GPS( node ) );
 168             _explicitGps = true;
 169         } else if ( name == "gsdi" ) {
 170             set_subsystem( id, new GSDI( node ) );
 171
 172         } else if ( name == "heading-indicator" ) {
 173             set_subsystem( id, new HeadingIndicator( node ) );
 174
 175         } else if ( name == "heading-indicator-fg" ) {
 176             set_subsystem( id, new HeadingIndicatorFG( node ) );
 177
 178         } else if ( name == "heading-indicator-dg" ) {
 179             set_subsystem( id, new HeadingIndicatorDG( node ) );
 180
 181         } else if ( name == "KR-87" ) {
 182             set_subsystem( id, new FGKR_87( node ) );
 183
 184         } else if ( name == "KT-70" ) {
 185             set_subsystem( id, new FGKT_70( node ) );
 186
 187         } else if ( name == "magnetic-compass" ) {
 188             set_subsystem( id, new MagCompass( node ) );
 189
 190         } else if ( name == "marker-beacon" ) {
 191             set_subsystem( id, new FGMarkerBeacon( node ), 0.2 );
 192
 193         } else if ( name == "nav-radio" ) {
 194             set_subsystem( id, Instrumentation::NavRadio::createInstance( node ) );
 195
 196         } else if ( name == "slip-skid-ball" ) {
 197             set_subsystem( id, new SlipSkidBall( node ), 0.03 );
 198
 199         } else if ( name == "transponder" ) {
 200             set_subsystem( id, new Transponder( node ), 0.2 );
 201
 202         } else if ( name == "turn-indicator" ) {
 203             set_subsystem( id, new TurnIndicator( node ) );
 204
 205         } else if ( name == "vertical-speed-indicator" ) {
 206             set_subsystem( id, new VerticalSpeedIndicator( node ) );
 207
 208         } else if ( name == "radar" ) {
 209             set_subsystem( id, new wxRadarBg ( node ) );
 210
 211         } else if ( name == "inst-vertical-speed-indicator" ) {
 212             set_subsystem( id, new InstVerticalSpeedIndicator( node ) );
 213
 214         } else if ( name == "tacan" ) {
 215             set_subsystem( id, new TACAN( node ), 0.2 );
 216
 217         } else if ( name == "mk-viii" ) {
 218             set_subsystem( id, new MK_VIII( node ), 0.2);
 219
 220         } else if ( name == "master-reference-gyro" ) {
 221             set_subsystem( id, new MasterReferenceGyro( node ) );
 222
 223         } else if ( name == "groundradar" ) {
 224             set_subsystem( id, new GroundRadar( node ) );
 225
 226         } else if ( name == "air-ground-radar" ) {
 227             set_subsystem( id, new agRadar( node ) );
 228
 229         } else if ( name == "radar-altimeter" ) {
 230             set_subsystem( id, new radAlt( node ) );
 231
 232         } else if ( name == "tcas" ) {
 233             set_subsystem( id, new TCAS( node ), 0.2);
 234
 235         } else if ( name == "navigation-display" ) {
 236             set_subsystem( id, new NavDisplay( node ) );
 237
 238         } else {
 239             SG_LOG( SG_ALL, SG_ALERT, "Unknown top level section: "
 240                     << name );
 241             return false;
 242         }
 243     }
 244     return true;
 245 }
 246
 247 // end of instrument_manager.cxx