src/Main/globals.hxx

   1 // globals.hxx -- Global state that needs to be shared among the sim modules
   2 //
   3 // Written by Curtis Olson, started July 2000.
   4 //
   5 // Copyright (C) 2000  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 #ifndef _GLOBALS_HXX
  25 #define _GLOBALS_HXX
  26
  27
  28 #include <simgear/ephemeris/ephemeris.hxx>
  29 #include <simgear/magvar/magvar.hxx>
  30 #include <simgear/route/route.hxx>
  31 #include <simgear/timing/sg_time.hxx>
  32 #include <simgear/misc/props.hxx>
  33
  34 #include "options.hxx"
  35 #include "viewmgr.hxx"
  36
  37
  38 class FGGlobals {
  39
  40 private:
  41
  42     // Root of FlightGear data tree
  43     string fg_root;
  44
  45     // Root of FlightGear scenery tree
  46     string fg_scenery;
  47
  48     // Freeze sim
  49     bool freeze;
  50
  51     // An offset in seconds from the true time.  Allows us to adjust
  52     // the effective time of day.
  53     long int warp;
  54
  55     // How much to change the value of warp each iteration.  Allows us
  56     // to make time progress faster than normal (or even run in reverse.)
  57     long int warp_delta;
  58
  59     // Time structure
  60     SGTime *time_params;
  61
  62     // Sky structures
  63     SGEphemeris *ephem;
  64
  65     // Magnetic Variation
  66     SGMagVar *mag;
  67
  68     // Global autopilot "route"
  69     SGRoute *route;
  70
  71     // options
  72     class FGOptions *options;
  73
  74     // viewer maneger
  75     FGViewMgr *viewmgr;
  76     FGViewer *current_view;
  77
  78     // properties
  79     SGPropertyNode *props;
  80
  81     // list of serial port-like configurations
  82     string_list channel_options_list;
  83
  84 public:
  85
  86     FGGlobals();
  87     ~FGGlobals();
  88
  89     inline const string &get_fg_root () const { return fg_root; }
  90     inline void set_fg_root (const string &root) { fg_root = root; }
  91
  92     inline const string &get_fg_scenery () const { return fg_scenery; }
  93     inline void set_fg_scenery (const string &scenery) {
  94       fg_scenery = scenery;
  95     }
  96
  97     inline bool get_freeze() const { return freeze; }
  98     inline void set_freeze( bool f ) { freeze = f; }
  99
 100     inline long int get_warp() const { return warp; }
 101     inline void set_warp( long int w ) { warp = w; }
 102     inline void inc_warp( long int w ) { warp += w; }
 103
 104     inline long int get_warp_delta() const { return warp_delta; }
 105     inline void set_warp_delta( long int d ) { warp_delta = d; }
 106     inline void inc_warp_delta( long int d ) { warp_delta += d; }
 107
 108     inline SGTime *get_time_params() const { return time_params; }
 109     inline void set_time_params( SGTime *t ) { time_params = t; }
 110
 111     inline SGEphemeris *get_ephem() const { return ephem; }
 112     inline void set_ephem( SGEphemeris *e ) { ephem = e; }
 113
 114     inline SGMagVar *get_mag() const { return mag; }
 115     inline void set_mag( SGMagVar *m ) { mag = m; }
 116
 117     inline SGRoute *get_route() const { return route; }
 118     inline void set_route( SGRoute *r ) { route = r; }
 119
 120     inline FGOptions *get_options() const { return options; }
 121     inline void set_options( FGOptions *o ) { options = o; }
 122
 123     inline FGViewMgr *get_viewmgr() const { return viewmgr; }
 124     inline void set_viewmgr( FGViewMgr *vm ) { viewmgr = vm; }
 125     inline FGViewer *get_current_view() const { return current_view; }
 126     inline void set_current_view( FGViewer *v ) { current_view = v; }
 127
 128     inline SGPropertyNode *get_props () { return props; }
 129     inline void set_props( SGPropertyNode *n ) { props = n; }
 130
 131     inline string_list get_channel_options_list () {
 132       return channel_options_list;
 133     }
 134
 135 };
 136
 137
 138 extern FGGlobals *globals;
 139
 140
 141 #endif // _GLOBALS_HXX
 142
 143