X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fstructure%2Fsubsystem_mgr.hxx;h=60313fd4a3543a8f723f233dc66c660a0ecd2951;hb=c82df0590dd46347e2f1d0dca4cc3712f67f3654;hp=03cbbb8d6effdd7b7a2da1e209346c09cbf9a209;hpb=5d34eb12e07235fc56d6a5e496b0c2e208fd7381;p=simgear.git diff --git a/simgear/structure/subsystem_mgr.hxx b/simgear/structure/subsystem_mgr.hxx index 03cbbb8d..60313fd4 100644 --- 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,31 @@ #include -#if 0 -#ifdef HAVE_WINDOWS_H -# include -# include -#endif +#include +#include +#include -#include STL_STRING -SG_USING_STD(string); +#include +#include +#include "SGSmplstat.hxx" -#include -SG_USING_STD(vector); -#endif -#include -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 +typedef std::vector eventTimeVec; +typedef std::vector::iterator eventTimeVecIterator; @@ -113,7 +121,7 @@ SG_USING_STD(map); * subsystems may also override the suspend() and resume() methods to * take different actions.

*/ -class SGSubsystem +class SGSubsystem : public SGReferenced { public: @@ -161,6 +169,16 @@ public: virtual void reinit (); + /** + * Shutdown the subsystem. + * + *

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. + *

+ */ + virtual void shutdown (); + /** * Acquire the subsystem's property bindings. * @@ -236,10 +254,42 @@ public: virtual bool is_suspended () const; + /** + * Keep track of execution time. + * + *

This method keeps track of timing statistics for each subsystem.

+ * + * @param time execution time in ms of last call. + */ + void updateExecutionTime(double time); + + /** + * Print details of execution time. + * + *

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

+ */ + void printTimingInformation(); + + /** + * 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; + //int test; + }; @@ -257,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); @@ -264,32 +315,52 @@ 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 printTimingStatistics(double minMaxTime=0.0,double minJitter=0.0); + + /** + * + */ + 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); - - string name; + void printTimingInformation(double time); + void printTimingStatistics(double minMaxTime=0.0,double minJitter=0.0); + void updateExecutionTime(double time); + double getTimeWarningThreshold(); + void collectDebugTiming (bool collect) { collectTimeStats = collect; }; + + SampleStatistic timeStat; + 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 _members; + std::vector _members; + + double _fixedUpdateTime; + double _updateTimeRemainder; }; @@ -321,6 +392,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 }; @@ -330,6 +404,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,14 +417,25 @@ 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); + void printTimingStatistics(double minMaxTime=0.0,double minJitter=0.0); private: - SGSubsystemGroup _groups[MAX_GROUPS]; - map _subsystem_map; + SGSubsystemGroup* _groups[MAX_GROUPS]; + + typedef std::map SubsystemDict; + SubsystemDict _subsystem_map; };