#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);
-#include <simgear/props/props.hxx>
#include <simgear/timing/timestamp.hxx>
+#include <simgear/structure/SGSharedPtr.hxx>
+#include "SGSmplstat.hxx"
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
* subsystems may also override the suspend() and resume() methods to
* take different actions.</p>
*/
-class SGSubsystem
+class SGSubsystem : public SGReferenced
{
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.
*
*/
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 std::string& name);
+
protected:
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);
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);
- void printTimingInformation();
-
- 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<Member *> _members;
+ std::vector<Member *> _members;
+
+ double _fixedUpdateTime;
+ double _updateTimeRemainder;
};
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
};
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);
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<string,SGSubsystem *> _subsystem_map;
+ SGSubsystemGroup* _groups[MAX_GROUPS];
+
+ typedef std::map<std::string, SGSubsystem*> SubsystemDict;
+ SubsystemDict _subsystem_map;
};
projects / simgear.git / blobdiff