QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsProfileExporter Class Reference

Handles exports of elevation profiles in various formats. More...

#include <qgsprofileexporter.h>

Public Member Functions

 QgsProfileExporter (const QgsProfileExporter &other)=delete
 QgsProfileExporter cannot be copied.
 
 QgsProfileExporter (const QList< QgsAbstractProfileSource * > &sources, const QgsProfileRequest &request, Qgis::ProfileExportType type)
 Constructor for QgsProfileExporter, using the provided list of profile sources to generate the results.
 
 ~QgsProfileExporter ()
 
QgsProfileExporteroperator= (const QgsProfileExporter &other)=delete
 QgsProfileExporter cannot be copied.
 
void run (QgsFeedback *feedback=nullptr)
 Runs the profile generation.
 
QList< QgsVectorLayer * > toLayers ()
 Returns a list of vector layer containing the exported profile results.
 

Detailed Description

Handles exports of elevation profiles in various formats.

Since
QGIS 3.32

Definition at line 36 of file qgsprofileexporter.h.

Constructor & Destructor Documentation

◆ QgsProfileExporter() [1/2]

QgsProfileExporter::QgsProfileExporter ( const QList< QgsAbstractProfileSource * > &  sources,
const QgsProfileRequest request,
Qgis::ProfileExportType  type 
)

Constructor for QgsProfileExporter, using the provided list of profile sources to generate the results.

After construction, call run() to initiate the profile generation.

Definition at line 29 of file qgsprofileexporter.cpp.

◆ QgsProfileExporter() [2/2]

QgsProfileExporter::QgsProfileExporter ( const QgsProfileExporter other)
delete

QgsProfileExporter cannot be copied.

◆ ~QgsProfileExporter()

QgsProfileExporter::~QgsProfileExporter ( )
default

Member Function Documentation

◆ operator=()

QgsProfileExporter & QgsProfileExporter::operator= ( const QgsProfileExporter other)
delete

QgsProfileExporter cannot be copied.

◆ run()

void QgsProfileExporter::run ( QgsFeedback feedback = nullptr)

Runs the profile generation.

This method must be called before retrieving any results from the exporter.

This method is safe to run in a background thread.

Definition at line 45 of file qgsprofileexporter.cpp.

◆ toLayers()

QList< QgsVectorLayer * > QgsProfileExporter::toLayers ( )

Returns a list of vector layer containing the exported profile results.

While this method attempts to condense all results into a single layer, multiple layers may be returned when the geometry types of exported features differs.

Ownership of the returned layers is transferred to the caller.

Definition at line 57 of file qgsprofileexporter.cpp.


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