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

#include <qgsruntimeprofiler.h>

Public Member Functions

 QgsScopedRuntimeProfile (const QString &name)
 Constructor for QgsScopedRuntimeProfile. More...
 
 ~QgsScopedRuntimeProfile ()
 Records the final runtime of the operation in the profiler instance. More...
 

Detailed Description

Scoped object for logging of the runtime for a single operation or group of operations.

This class automatically takes care of registering an operation in the QgsApplication::profiler() registry upon construction, and recording of the elapsed runtime upon destruction.

Python scripts should not use QgsScopedRuntimeProfile directly. Instead, use QgsRuntimeProfiler.profile()

with QgsRuntimeProfiler.profile('My operation'):
# do something
Since
QGIS 3.14

Definition at line 115 of file qgsruntimeprofiler.h.

Constructor & Destructor Documentation

◆ QgsScopedRuntimeProfile()

QgsScopedRuntimeProfile::QgsScopedRuntimeProfile ( const QString &  name)

Constructor for QgsScopedRuntimeProfile.

Automatically registers the operation in the QgsApplication::profiler() instance and starts recording the run time of the operation.

Definition at line 127 of file qgsruntimeprofiler.cpp.

◆ ~QgsScopedRuntimeProfile()

QgsScopedRuntimeProfile::~QgsScopedRuntimeProfile ( )

Records the final runtime of the operation in the profiler instance.

Definition at line 132 of file qgsruntimeprofiler.cpp.


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