QGIS API Documentation  2.99.0-Master (ae4d26a)
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...
 
void beginGroup (const QString &name)
 Begin the group for the profiler. More...
 
void clear ()
 clear Clear all profile data. More...
 
void end ()
 End the current profile event. More...
 
void endGroup ()
 End the current active group. More...
 
const QList< QPair< QString, double > > profileTimes () const
 Return all the current profile times. 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 15 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.

Definition at line 4 of file qgsruntimeprofiler.cpp.

◆ clear()

void QgsRuntimeProfiler::clear ( )

clear Clear all profile data.

Definition at line 43 of file qgsruntimeprofiler.cpp.

◆ end()

void QgsRuntimeProfiler::end ( )

End the current profile event.

Definition at line 34 of file qgsruntimeprofiler.cpp.

◆ endGroup()

void QgsRuntimeProfiler::endGroup ( )

End the current active group.

Definition at line 14 of file qgsruntimeprofiler.cpp.

◆ profileTimes()

const QList<QPair<QString, double > > QgsRuntimeProfiler::profileTimes ( ) const
inline

Return all the current profile times.

Returns
A list of profile event names and times.
Note
not available in Python bindings

Definition at line 53 of file qgsruntimeprofiler.h.

◆ 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 28 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 48 of file qgsruntimeprofiler.cpp.


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