Revert "Use simgear internal stuff for the singleton class."

[simgear.git] / simgear / structure / subsystem_mgr.hxx

diff --git a/simgear/structure/subsystem_mgr.hxx b/simgear/structure/subsystem_mgr.hxx
index 03cbbb8d6effdd7b7a2da1e209346c09cbf9a209..a0e76809c8a3522ddff53b49927248442ab21eff 100644 (file)
--- a/simgear/structure/subsystem_mgr.hxx
+++ b/simgear/structure/subsystem_mgr.hxx
@@ -1,3 +1,4 @@
+
 // Written by David Megginson, started 2000-12
 //
 // Copyright (C) 2000  David Megginson, david@megginson.com
@@ -14,7 +15,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
@@ -25,24 +26,34 @@
 
 #include <simgear/compiler.h>
 
-#if 0
-#ifdef HAVE_WINDOWS_H
-#  include <windows.h>                     
-#  include <float.h>                    
-#endif
+#include <string>
+#include <map>
+#include <vector>
 
-#include STL_STRING
-SG_USING_STD(string);
+#include <simgear/timing/timestamp.hxx>
+#include <simgear/structure/SGSharedPtr.hxx>
 
-#include <vector>
-SG_USING_STD(vector);
-#endif
 
-#include <map>
-SG_USING_STD(map);
+class TimingInfo
+{
+private:
+    std::string eventName;
+    SGTimeStamp time;
+
+public: 
+    TimingInfo(const std::string& name, const SGTimeStamp &t) :
+        eventName(name), time(t)
+    { }
+    const std::string& getName() const { return eventName; }
+    const SGTimeStamp& getTime() const { return time; }
+};
 
-#include <simgear/props/props.hxx>
+class SampleStatistic;
 
+typedef std::vector<TimingInfo> eventTimeVec;
+typedef std::vector<TimingInfo>::iterator eventTimeVecIterator;
+
+typedef void (*SGSubsystemTimingCb)(void* userData, const std::string& name, SampleStatistic* pStatistic);
 
 \f
 /**
@@ -113,7 +124,7 @@ SG_USING_STD(map);
  * subsystems may also override the suspend() and resume() methods to
  * take different actions.</p>
  */
-class SGSubsystem
+class SGSubsystem : public SGReferenced
 {
 public:
 
@@ -161,6 +172,16 @@ public:
   virtual void reinit ();
 
 
+  /**
+   * Shutdown the subsystem.
+   *
+   * <p>Release any state associated with subsystem. Shutdown happens in
+   * the reverse order to init(), so this is the correct place to do
+   * shutdown that depends on other subsystems.
+   * </p>
+   */
+  virtual void shutdown ();
+   
   /**
    * Acquire the subsystem's property bindings.
    *
@@ -209,7 +230,7 @@ public:
 
 
   /**
-   * Suspend or resum operation of this subsystem.
+   * Suspend or resume operation of this subsystem.
    *
    * @param suspended true if the subsystem should be suspended, false
    * otherwise.
@@ -235,11 +256,25 @@ public:
    */
   virtual bool is_suspended () const;
 
+  /**
+   * Trigger the callback to report timing information for all subsystems.
+   */
+  void reportTiming(void);
+
+  /**
+   * Place time stamps at strategic points in the execution of subsystems 
+   * update() member functions. Predominantly for debugging purposes.
+   */
+  void stamp(const std::string& name);
 
 protected:
 
   bool _suspended;
 
+  eventTimeVec timingInfo;
+
+  static SGSubsystemTimingCb reportTimingCb;
+  static void* reportTimingUserData;
 };
 
 
@@ -257,6 +292,7 @@ public:
     virtual void init ();
     virtual void postinit ();
     virtual void reinit ();
+    virtual void shutdown ();
     virtual void bind ();
     virtual void unbind ();
     virtual void update (double delta_time_sec);
@@ -264,32 +300,28 @@ public:
     virtual void resume ();
     virtual bool is_suspended () const;
 
-    virtual void set_subsystem (const string &name,
+    virtual void set_subsystem (const std::string &name,
                                 SGSubsystem * subsystem,
                                 double min_step_sec = 0);
-    virtual SGSubsystem * get_subsystem (const string &name);
-    virtual void remove_subsystem (const string &name);
-    virtual bool has_subsystem (const string &name) const;
-
-private:
+    virtual SGSubsystem * get_subsystem (const std::string &name);
+    virtual void remove_subsystem (const std::string &name);
+    virtual bool has_subsystem (const std::string &name) const;
 
-    struct Member {
+    void reportTiming(void);
 
-        Member ();
-        Member (const Member &member);
-        virtual ~Member ();
-
-        virtual void update (double delta_time_sec);
-
-        string name;
-        SGSubsystem * subsystem;
-        double min_step_sec;
-        double elapsed_sec;
-    };
+    /**
+     *
+     */
+    void set_fixed_update_time(double fixed_dt);
+private:
 
-    Member * get_member (const string &name, bool create = false);
+    class Member;
+    Member* get_member (const std::string &name, bool create = false);
 
-    vector<Member *> _members;
+    std::vector<Member *> _members;
+    
+    double _fixedUpdateTime;
+    double _updateTimeRemainder;
 };
 
 
@@ -321,6 +353,10 @@ public:
     enum GroupType {
         INIT = 0,
         GENERAL,
+        FDM,        ///< flight model, autopilot, instruments that run coupled
+        POST_FDM,   ///< certain subsystems depend on FDM data
+        DISPLAY,    ///< view, camera, rendering updates
+        SOUND/*I want to be last!*/,  ///< needs to run AFTER display, to allow concurrent GPU/sound processing
         MAX_GROUPS
     };
 
@@ -330,6 +366,7 @@ public:
     virtual void init ();
     virtual void postinit ();
     virtual void reinit ();
+    virtual void shutdown ();
     virtual void bind ();
     virtual void unbind ();
     virtual void update (double delta_time_sec);
@@ -342,15 +379,24 @@ public:
                       GroupType group = GENERAL, 
                       double min_time_sec = 0);
 
+    /**
+     * remove a subsystem, and return a pointer to it.
+     * returns NULL if the subsystem was not found.
+     */
+    virtual SGSubsystem* remove(const char* name);
+
     virtual SGSubsystemGroup * get_group (GroupType group);
 
-    virtual SGSubsystem * get_subsystem(const string &name);
+    virtual SGSubsystem * get_subsystem(const std::string &name) const;
 
-private:
+    void reportTiming();
+    void setReportTimingCb(void* userData,SGSubsystemTimingCb cb) {reportTimingCb = cb;reportTimingUserData = userData;}
 
-    SGSubsystemGroup _groups[MAX_GROUPS];
-    map<string,SGSubsystem *> _subsystem_map;
+private:
+    SGSubsystemGroup* _groups[MAX_GROUPS];
 
+    typedef std::map<std::string, SGSubsystem*> SubsystemDict;
+    SubsystemDict _subsystem_map;
 };