File: qgsruntimeprofiler.sip

package info (click to toggle)
qgis 2.18.28%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,007,948 kB
  • sloc: cpp: 671,774; python: 158,539; xml: 35,690; ansic: 8,346; sh: 1,766; perl: 1,669; sql: 999; yacc: 836; lex: 461; makefile: 292
file content (62 lines) | stat: -rw-r--r-- 1,595 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class QgsRuntimeProfiler
{
%TypeHeaderCode
#include <qgsruntimeprofiler.h>
%End
  public:
    /**
     * @brief Instance of the run time profiler. To use the main profiler
     * use this instance.
     * @return The instance of the run time profiler
     */
    QgsRuntimeProfiler();

    /**
     * @brief Begin the group for the profiler. Groups will append {GroupName}/ to the
     * front of the profile tag set using start.
     * @param name The name of the group.
     */
    static QgsRuntimeProfiler * instance();

    /**
     * @brief Begin the group for the profiler. Groups will append {GroupName}/ to the
     * front of the profile tag set using start.
     * @param name The name of the group.
     */
    void beginGroup( const QString& name );

    /**
     * @brief End the current active group.
     */
    void endGroup();

    /**
     * @brief Start a profile event with the given name.
     * @param name The name of the profile event. Will have the name of
     * the active group appened after ending.
     */
    void start( const QString& name );

    /**
     * @brief End the current profile event.
     */
    void end();

    /**
     * @brief Return all the current profile times.
     * @return A list of profile event names and times.
     */
     const QList<QPair<QString, double>> profileTimes() const;

    /**
     * @brief clear Clear all profile data.
     */
    void clear();

    /**
     * @brief The current total time collected in the profiler.
     * @return The current total time collected in the profiler.
     */
    double totalTime();

};