Formal shutdown interface on SGSubsystem.

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

diff --git a/simgear/structure/subsystem_mgr.hxx b/simgear/structure/subsystem_mgr.hxx
index e763351459f7107935f12777937840ad704b1d88..c49d73fd2db8d143bf3ae47ae606c4aa29cc6848 100644 (file)
--- a/simgear/structure/subsystem_mgr.hxx
+++ b/simgear/structure/subsystem_mgr.hxx
@@ -28,9 +28,6 @@
 #include <string>
 #include <map>
 #include <vector>
-SG_USING_STD(map);
-SG_USING_STD(vector);
-SG_USING_STD(string);
 
 #include <simgear/props/props.hxx>
 #include <simgear/timing/timestamp.hxx>
@@ -40,17 +37,19 @@ SG_USING_STD(string);
 class TimingInfo
 {
 private:
-    string eventName;
+    std::string eventName;
     SGTimeStamp time;
 
 public: 
-    TimingInfo(string name, SGTimeStamp &t) { eventName = name; time = t;};
-    string getName() { return eventName; };
-    SGTimeStamp getTime() { return time; };
+    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; }
 };
 
-typedef vector<TimingInfo> eventTimeVec;
-typedef vector<TimingInfo>::iterator eventTimeVecIterator;
+typedef std::vector<TimingInfo> eventTimeVec;
+typedef std::vector<TimingInfo>::iterator eventTimeVecIterator;
 
 
 \f
@@ -170,6 +169,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.
    *
@@ -270,7 +279,7 @@ public:
    * Place time stamps at strategic points in the execution of subsystems 
    * update() member functions. Predominantly for debugging purposes.
    */
-  void stamp(string name);
+  void stamp(const std::string& name);
   
 
 
@@ -298,6 +307,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);
@@ -305,21 +315,27 @@ 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;
+    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;
 
     void collectDebugTiming(bool collect);
 
+    /**
+     * 
+     */
+    void set_fixed_update_time(double fixed_dt);
 private:
 
-    struct Member {
+    class Member {
 
-        Member ();
+    private:
         Member (const Member &member);
+    public:
+        Member ();
         virtual ~Member ();
 
         virtual void update (double delta_time_sec);
@@ -330,16 +346,20 @@ private:
         void collectDebugTiming (bool collect) { collectTimeStats = collect; };
 
         SampleStatistic timeStat;
-        string name;
+        std::string name;
         SGSubsystem * subsystem;
         double min_step_sec;
         double elapsed_sec;
         bool collectTimeStats;
+        int exceptionCount;
     };
 
-    Member * get_member (const string &name, bool create = false);
+    Member * get_member (const std::string &name, bool create = false);
 
-    vector<Member *> _members;
+    std::vector<Member *> _members;
+    
+    double _fixedUpdateTime;
+    double _updateTimeRemainder;
 };
 
 
@@ -371,6 +391,9 @@ 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
         MAX_GROUPS
     };
 
@@ -380,6 +403,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);
@@ -392,16 +416,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;
 
    void collectDebugTiming(bool collect);
 
 private:
 
-    SGSubsystemGroup _groups[MAX_GROUPS];
-    map<string,SGSubsystem *> _subsystem_map;
+    SGSubsystemGroup* _groups[MAX_GROUPS];
+    
+    typedef std::map<std::string, SGSubsystem*> SubsystemDict;
+    SubsystemDict _subsystem_map;
 
 };