Make use of posix clocks if available.

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

diff --git a/simgear/structure/subsystem_mgr.hxx b/simgear/structure/subsystem_mgr.hxx
index a4844903c4f2e897cf9efa00d7292fdb7cea9860..a751d30699426c14561447c1acbd741e78421384 100644 (file)
--- a/simgear/structure/subsystem_mgr.hxx
+++ b/simgear/structure/subsystem_mgr.hxx
@@ -25,28 +25,17 @@
 
 #include <simgear/compiler.h>
 
-#if 0
-#ifdef HAVE_WINDOWS_H
-#  include <windows.h>
-#  include <float.h>
-#endif
-
-#include STL_STRING
-SG_USING_STD(string);
-
-#include <vector>
-SG_USING_STD(vector);
-#endif
-
 #include <string>
 #include <map>
 #include <vector>
-SG_USING_STD(map);
-SG_USING_STD(vector);
-SG_USING_STD(string);
+
+using std::map;
+using std::vector;
+using std::string;
 
 #include <simgear/props/props.hxx>
 #include <simgear/timing/timestamp.hxx>
+#include "SGSmplstat.hxx"
 
 
 class TimingInfo
@@ -56,9 +45,11 @@ private:
     SGTimeStamp time;
 
 public: 
-    TimingInfo(string name, SGTimeStamp &t) { eventName = name; time = t;};
-    string getName() { return eventName; };
-    SGTimeStamp getTime() { return time; };
+    TimingInfo(const string& name, const SGTimeStamp &t) :
+        eventName(name), time(t)
+    { }
+    const string& getName() const { return eventName; }
+    const SGTimeStamp& getTime() const { return time; }
 };
 
 typedef vector<TimingInfo> eventTimeVec;
@@ -134,7 +125,7 @@ typedef vector<TimingInfo>::iterator eventTimeVecIterator;
  * subsystems may also override the suspend() and resume() methods to
  * take different actions.</p>
  */
-class SGSubsystem
+class SGSubsystem : public SGReferenced
 {
 public:
 
@@ -256,9 +247,34 @@ public:
    */
   virtual bool is_suspended () const;
 
+
+  /**
+   * Keep track of execution time.
+   *
+   * <p>This method keeps track of timing statistics for each subsystem.</p>
+   * 
+   * @param time execution time in ms of last call.
+   */
+  void updateExecutionTime(double time);
+
+  /**
+   * Print details of execution time.
+   *
+   * <p>For debugging purposes, developers can place stamp() calls
+   * at strategic points in the update() function of each subsystem, which 
+   * record the time between the successive calls to stamp. This method,
+   * printExecutionTime() is called after exectution of the subsystem
+   * update function itself to conduct a post-hoc analysis of excecution
+   * time</p>
+   */ 
   void printTimingInformation();
 
-  void stamp(string name);
+  /**
+   * Place time stamps at strategic points in the execution of subsystems 
+   * update() member functions. Predominantly for debugging purposes.
+   */
+  void stamp(const string& name);
+  
 
 
 protected:
@@ -299,22 +315,31 @@ public:
     virtual void remove_subsystem (const string &name);
     virtual bool has_subsystem (const string &name) const;
 
+    void collectDebugTiming(bool collect);
 
 private:
 
-    struct Member {
+    class Member {
 
-        Member ();
+    private:
         Member (const Member &member);
+    public:
+        Member ();
         virtual ~Member ();
 
         virtual void update (double delta_time_sec);
-       void printTimingInformation();
+       void printTimingInformation(double time);
+        void printTimingStatistics();
+        void updateExecutionTime(double time);
+        double getTimeWarningThreshold();
+        void collectDebugTiming (bool collect) { collectTimeStats = collect; };
 
+        SampleStatistic timeStat;
         string name;
         SGSubsystem * subsystem;
         double min_step_sec;
         double elapsed_sec;
+        bool collectTimeStats;
     };
 
     Member * get_member (const string &name, bool create = false);
@@ -376,6 +401,8 @@ public:
 
     virtual SGSubsystem * get_subsystem(const string &name);
 
+   void collectDebugTiming(bool collect);
+
 private:
 
     SGSubsystemGroup _groups[MAX_GROUPS];