← Back to branch summary

~ubuntu-branches/ubuntu/utopic/blender/utopic-proposed

« back to all changes in this revision

Viewing changes to source/gameengine/Ketsji/KX_TimeCategoryLogger.h

  • Committer: Package Import Robot
  • Author(s): Matteo F. Vescovi
  • Date: 2012-04-28 12:11:12 UTC
  • mto: (14.1.6 experimental) (1.5.1)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: package-import@ubuntu.com-20120428121112-2zi0vp8b6vejda8i
Tags: upstream-2.63
Import upstream version 2.63

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/gameengine/Ketsji/KX_TimeCategoryLogger.h
29
29
 *  \ingroup ketsji
30
30
 */
31
31
 
32
 
#ifndef __KX_TIME_CATEGORY_LOGGER_H
33
 
#define __KX_TIME_CATEGORY_LOGGER_H
 
32
#ifndef __KX_TIMECATEGORYLOGGER_H__
 
33
#define __KX_TIMECATEGORYLOGGER_H__
34
34
 
35
35
#if defined(WIN32) && !defined(FREE_WINDOWS)
36
36
#pragma warning (disable:4786) // suppress stl-MSVC debug info warning
52
52
 
53
53
        /**
54
54
         * Constructor.
55
 
         * @param maxNumMesasurements Maximum number of measurements stored (> 1).
 
55
         * \param maxNumMesasurements Maximum number of measurements stored (> 1).
56
56
         */
57
57
        KX_TimeCategoryLogger(unsigned int maxNumMeasurements = 10);
58
58
 
73
73
 
74
74
        /**
75
75
         * Adds a category.
76
 
         * @param category      The new category.
 
76
         * \param category      The new category.
77
77
         */
78
78
        virtual void AddCategory(TimeCategory tc);
79
79
 
80
80
        /**
81
81
         * Starts logging in current measurement for the given category.
82
 
         * @param tc                                    The category to log to.
83
 
         * @param now                                   The current time.
84
 
         * @param endOtherCategories    Whether to stop logging to other categories.
 
82
         * \param tc                                    The category to log to.
 
83
         * \param now                                   The current time.
 
84
         * \param endOtherCategories    Whether to stop logging to other categories.
85
85
         */
86
86
        virtual void StartLog(TimeCategory tc, double now, bool endOtherCategories = true);
87
87
 
88
88
        /**
89
89
         * End logging in current measurement for the given category.
90
 
         * @param tc    The category to log to.
91
 
         * @param now   The current time.
 
90
         * \param tc    The category to log to.
 
91
         * \param now   The current time.
92
92
         */
93
93
        virtual void EndLog(TimeCategory tc, double now);
94
94
 
95
95
        /**
96
96
         * End logging in current measurement for all categories.
97
 
         * @param now   The current time.
 
97
         * \param now   The current time.
98
98
         */
99
99
        virtual void EndLog(double now);
100
100
 
101
101
        /**
102
102
         * Logs time in next measurement.
103
 
         * @param now   The current time.
 
103
         * \param now   The current time.
104
104
         */
105
105
        virtual void NextMeasurement(double now);
106
106
 
107
107
        /**
108
108
         * Returns average of all but the current measurement time.
109
 
         * @return The average of all but the current measurement.
 
109
         * \return The average of all but the current measurement.
110
110
         */
111
111
        virtual double GetAverage(TimeCategory tc);
112
112
 
135
135
#endif
136
136
};
137
137
 
138
 
#endif // __KX_TIME_CATEGORY_LOGGER_H
 
138
#endif // __KX_TIMECATEGORYLOGGER_H__
139
139