mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-16 00:05:45 -04:00
a913a6aa5a
to ease logging of runtime profiles.
Now it's possible to do:
with QgsRuntimeProfiler.profile('My operation'):
# do something
to automatically handle everything required to log the operation runtime
128 lines
3.3 KiB
Plaintext
128 lines
3.3 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsruntimeprofiler.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
class QgsRuntimeProfiler
|
|
{
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsruntimeprofiler.h"
|
|
%End
|
|
public:
|
|
|
|
QgsRuntimeProfiler();
|
|
%Docstring
|
|
Constructor to create a new runtime profiler.
|
|
%End
|
|
|
|
void beginGroup( const QString &name ) /Deprecated/;
|
|
%Docstring
|
|
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.
|
|
|
|
.. deprecated::
|
|
use start() instead
|
|
%End
|
|
|
|
void endGroup() /Deprecated/;
|
|
%Docstring
|
|
End the current active group.
|
|
|
|
.. deprecated::
|
|
use end() instead
|
|
%End
|
|
|
|
QStringList childGroups( const QString &parent = QString() ) const;
|
|
%Docstring
|
|
Returns a list of all child groups with the specified ``parent``.
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
void start( const QString &name );
|
|
%Docstring
|
|
Start a profile event with the given name.
|
|
|
|
:param name: The name of the profile event. Will have the name of
|
|
the active group appended after ending.
|
|
%End
|
|
|
|
void end();
|
|
%Docstring
|
|
End the current profile event.
|
|
%End
|
|
|
|
double profileTime( const QString &name ) const;
|
|
%Docstring
|
|
Returns the profile time for the specified ``name``.
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
void clear();
|
|
%Docstring
|
|
clear Clear all profile data.
|
|
%End
|
|
|
|
double totalTime();
|
|
%Docstring
|
|
The current total time collected in the profiler.
|
|
|
|
:return: The current total time collected in the profiler.
|
|
%End
|
|
|
|
};
|
|
|
|
|
|
class QgsScopedRuntimeProfile
|
|
{
|
|
%Docstring
|
|
|
|
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 :py:func:`QgsApplication.profiler()`
|
|
registry upon construction, and recording of the elapsed runtime upon destruction.
|
|
|
|
Python scripts should not use QgsScopedRuntimeProfile directly. Instead, use :py:func:`QgsRuntimeProfiler.profile()`
|
|
.. code-block:: python
|
|
|
|
with QgsRuntimeProfiler.profile('My operation'):
|
|
# do something
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsruntimeprofiler.h"
|
|
%End
|
|
public:
|
|
|
|
QgsScopedRuntimeProfile( const QString &name );
|
|
%Docstring
|
|
Constructor for QgsScopedRuntimeProfile.
|
|
|
|
Automatically registers the operation in the QgsApplication.profiler() instance
|
|
and starts recording the run time of the operation.
|
|
%End
|
|
|
|
~QgsScopedRuntimeProfile();
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsruntimeprofiler.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|