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 03cbbb8d6effdd7b7a2da1e209346c09cbf9a209..a751d30699426c14561447c1acbd741e78421384 100644 (file)
--- a/simgear/structure/subsystem_mgr.hxx
+++ b/simgear/structure/subsystem_mgr.hxx
@@ -14,7 +14,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,23 +25,35 @@
 
 #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 <string>
+#include <map>
 #include <vector>
-SG_USING_STD(vector);
-#endif
 
-#include <map>
-SG_USING_STD(map);
+using std::map;
+using std::vector;
+using std::string;
 
 #include <simgear/props/props.hxx>
+#include <simgear/timing/timestamp.hxx>
+#include "SGSmplstat.hxx"
+
+
+class TimingInfo
+{
+private:
+    string eventName;
+    SGTimeStamp time;
+
+public: 
+    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;
+typedef vector<TimingInfo>::iterator eventTimeVecIterator;
 
 
 \f
@@ -113,7 +125,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:
 
@@ -236,10 +248,42 @@ 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();
+
+  /**
+   * Place time stamps at strategic points in the execution of subsystems 
+   * update() member functions. Predominantly for debugging purposes.
+   */
+  void stamp(const string& name);
+  
+
+
 protected:
 
   bool _suspended;
 
+  eventTimeVec timingInfo;
+  //int test;
+
 };
 
 
@@ -271,20 +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(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);
@@ -346,6 +401,8 @@ public:
 
     virtual SGSubsystem * get_subsystem(const string &name);
 
+   void collectDebugTiming(bool collect);
+
 private:
 
     SGSubsystemGroup _groups[MAX_GROUPS];