src/FDM/fdm_shell.hxx

   1 // fdm_shell.hxx -- encapsulate FDM implementations as well-behaved subsystems
   2 //
   3 // Written by James Turner, started June 2010.
   4 //
   5 // Copyright (C) 2010  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 #ifndef FG_FDM_SHELL_HXX
  24 #define FG_FDM_SHELL_HXX
  25
  26 #include <simgear/structure/subsystem_mgr.hxx>
  27
  28 // forward decls
  29 class FGInterface;
  30
  31 /**
  32  * Wrap an FDM implementation in a subsystem with standard semantics
  33  * Notably, deal with the various cases in which update() should not
  34  * be called, such as replay or before scenery has loaded
  35  *
  36  * This class also provides the factory method which creates the
  37  * specific FDM class (createImplementation)
  38  */
  39 class FDMShell : public SGSubsystem
  40 {
  41 public:
  42   FDMShell();
  43   ~FDMShell();
  44
  45   virtual void init();
  46   virtual void reinit();
  47
  48   virtual void bind();
  49   virtual void unbind();
  50
  51   virtual void update(double dt);
  52
  53 private:
  54
  55   void createImplementation();
  56
  57   FGInterface* _impl;
  58   SGPropertyNode* _props; // root property tree for this FDM instance
  59   bool _dataLogging;
  60 };
  61
  62 #endif // of FG_FDM_SHELL_HXX