QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Public Member Functions | List of all members
QgsRuntimeProfiler Class Reference

#include <qgsruntimeprofiler.h>

Public Member Functions

 QgsRuntimeProfiler ()=default
 Constructor to create a new runtime profiler. More...
 
Q_DECL_DEPRECATED void beginGroup (const QString &name)
 Begin the group for the profiler. More...
 
QStringList childGroups (const QString &parent=QString()) const
 Returns a list of all child groups with the specified parent. More...
 
void clear ()
 clear Clear all profile data. More...
 
void end ()
 End the current profile event. More...
 
Q_DECL_DEPRECATED void endGroup ()
 End the current active group. More...
 
double profileTime (const QString &name) const
 Returns the profile time for the specified name. More...
 
void start (const QString &name)
 Start a profile event with the given name. More...
 
double totalTime ()
 The current total time collected in the profiler. More...
 

Detailed Description

Definition at line 31 of file qgsruntimeprofiler.h.

Constructor & Destructor Documentation

◆ QgsRuntimeProfiler()

QgsRuntimeProfiler::QgsRuntimeProfiler ( )
default

Constructor to create a new runtime profiler.

Member Function Documentation

◆ beginGroup()

void QgsRuntimeProfiler::beginGroup ( const QString &  name)

Begin the group for the profiler.

Groups will append {GroupName}/ to the front of the profile tag set using start.

Parameters
nameThe name of the group.
Deprecated:
use start() instead

Definition at line 21 of file qgsruntimeprofiler.cpp.

◆ childGroups()

QStringList QgsRuntimeProfiler::childGroups ( const QString &  parent = QString()) const

Returns a list of all child groups with the specified parent.

Since
QGIS 3.14

Definition at line 31 of file qgsruntimeprofiler.cpp.

◆ clear()

void QgsRuntimeProfiler::clear ( )

clear Clear all profile data.

Definition at line 107 of file qgsruntimeprofiler.cpp.

◆ end()

void QgsRuntimeProfiler::end ( )

End the current profile event.

Definition at line 67 of file qgsruntimeprofiler.cpp.

◆ endGroup()

void QgsRuntimeProfiler::endGroup ( )

End the current active group.

Deprecated:
use end() instead

Definition at line 26 of file qgsruntimeprofiler.cpp.

◆ profileTime()

double QgsRuntimeProfiler::profileTime ( const QString &  name) const

Returns the profile time for the specified name.

Since
QGIS 3.14

Definition at line 83 of file qgsruntimeprofiler.cpp.

◆ start()

void QgsRuntimeProfiler::start ( const QString &  name)

Start a profile event with the given name.

Parameters
nameThe name of the profile event. Will have the name of the active group appended after ending.

Definition at line 58 of file qgsruntimeprofiler.cpp.

◆ totalTime()

double QgsRuntimeProfiler::totalTime ( )

The current total time collected in the profiler.

Returns
The current total time collected in the profiler.

Definition at line 112 of file qgsruntimeprofiler.cpp.


The documentation for this class was generated from the following files: