QGIS API Documentation  3.23.0-Master (22c16f2067)
Public Member Functions | List of all members
QgsGeocoderContext Class Reference

Encapsulates the context of a geocoding operation. More...

#include <qgsgeocodercontext.h>

Public Member Functions

 QgsGeocoderContext (const QgsCoordinateTransformContext &transformContext)
 Constructor for QgsGeocoderContext, with the specified transformContext. More...
 
QgsGeometry areaOfInterest () const
 Returns the optional area of interest, which can be used to indicate the desired geographic area where geocoding results are desired. More...
 
QgsCoordinateReferenceSystem areaOfInterestCrs () const
 Returns the coordinate reference system for the area of interest, which can be used to indicate the desired geographic area where geocoding results are desired. More...
 
void setAreaOfInterest (const QgsGeometry &area)
 Sets the optional area of interest, which can be used to indicate the desired geographic area where geocoding results are desired. More...
 
void setAreaOfInterestCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the crs for the area of interest, which can be used to indicate the desired geographic area where geocoding results are desired. More...
 
void setTransformContext (const QgsCoordinateTransformContext &context)
 Sets the coordinate transform context, which should be used whenever the geocoder constructs a coordinate transform. More...
 
QgsCoordinateTransformContext transformContext () const
 Returns the coordinate transform context, which should be used whenever the geocoder constructs a coordinate transform. More...
 

Detailed Description

Encapsulates the context of a geocoding operation.

Since
QGIS 3.18

Definition at line 31 of file qgsgeocodercontext.h.

Constructor & Destructor Documentation

◆ QgsGeocoderContext()

QgsGeocoderContext::QgsGeocoderContext ( const QgsCoordinateTransformContext transformContext)

Constructor for QgsGeocoderContext, with the specified transformContext.

Definition at line 22 of file qgsgeocodercontext.cpp.

Member Function Documentation

◆ areaOfInterest()

QgsGeometry QgsGeocoderContext::areaOfInterest ( ) const
inline

Returns the optional area of interest, which can be used to indicate the desired geographic area where geocoding results are desired.

The area of interest can be a polygon geometry, in which case it represents the extent to use for filtering candidate results, or a point geometry, in which case it represents a "target point" for prioritizing closer results.

The coordinate reference system for the area of interest can be retrieved via areaOfInterestCrs().

See also
setAreaOfInterest()
areaOfInterestCrs()

Definition at line 71 of file qgsgeocodercontext.h.

◆ areaOfInterestCrs()

QgsCoordinateReferenceSystem QgsGeocoderContext::areaOfInterestCrs ( ) const
inline

Returns the coordinate reference system for the area of interest, which can be used to indicate the desired geographic area where geocoding results are desired.

See also
areaOfInterest()
setAreaOfInterestCrs()

Definition at line 96 of file qgsgeocodercontext.h.

◆ setAreaOfInterest()

void QgsGeocoderContext::setAreaOfInterest ( const QgsGeometry area)
inline

Sets the optional area of interest, which can be used to indicate the desired geographic area where geocoding results are desired.

The area of interest can be a polygon geometry, in which case it represents the extent to use for filtering candidate results, or a point geometry, in which case it represents a "target point" for prioritizing closer results.

The coordinate reference system for the area of interest can be set via setAreaOfInterestCrs().

See also
areaOfInterest()
setAreaOfInterestCrs()

Definition at line 87 of file qgsgeocodercontext.h.

◆ setAreaOfInterestCrs()

void QgsGeocoderContext::setAreaOfInterestCrs ( const QgsCoordinateReferenceSystem crs)
inline

Sets the crs for the area of interest, which can be used to indicate the desired geographic area where geocoding results are desired.

See also
areaOfInterestCrs()
setAreaOfInterest()

Definition at line 105 of file qgsgeocodercontext.h.

◆ setTransformContext()

void QgsGeocoderContext::setTransformContext ( const QgsCoordinateTransformContext context)
inline

Sets the coordinate transform context, which should be used whenever the geocoder constructs a coordinate transform.

See also
transformContext()

Definition at line 55 of file qgsgeocodercontext.h.

◆ transformContext()

QgsCoordinateTransformContext QgsGeocoderContext::transformContext ( ) const
inline

Returns the coordinate transform context, which should be used whenever the geocoder constructs a coordinate transform.

See also
setTransformContext()

Definition at line 47 of file qgsgeocodercontext.h.


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