Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Friends | List of all members
QPlaceMatchRequest Class Reference

\inmodule QtLocation More...

#include <qplacematchrequest.h>

+ Collaboration diagram for QPlaceMatchRequest:

Public Member Functions

 QPlaceMatchRequest ()
 Default constructor.
 
 QPlaceMatchRequest (const QPlaceMatchRequest &other) noexcept
 Constructs a copy of other.
 
 QPlaceMatchRequest (QPlaceMatchRequest &&other) noexcept=default
 
 ~QPlaceMatchRequest ()
 Destroys the request object.
 
QPlaceMatchRequest & operator= (const QPlaceMatchRequest &other) noexcept
 Assigns other to this search request and returns a reference to this match request.
 
void swap (QPlaceMatchRequest &other) noexcept
 
QList< QPlace > places () const
 Returns a list of places which are to be matched.
 
void setPlaces (const QList< QPlace > &places)
 Sets a list of places which are to be matched.
 
void setResults (const QList< QPlaceSearchResult > &results)
 Convenience function which uses a set of search results to set the places which should be matched.
 
QVariantMap parameters () const
 Returns the parameters for matching places.
 
void setParameters (const QVariantMap &parameters)
 Sets the parameters for matching places.
 
void clear ()
 Clears the match request.
 

Static Public Attributes

static const QString AlternativeId
 \variable QPlaceMatchRequest::AlternativeId The key to specify that matching is to be accomplished via an alternative place identifier.
 

Friends

bool operator== (const QPlaceMatchRequest &lhs, const QPlaceMatchRequest &rhs) noexcept
 Returns true if lhs is equal to rhs, otherwise returns false.
 
bool operator!= (const QPlaceMatchRequest &lhs, const QPlaceMatchRequest &rhs) noexcept
 Returns true if lhs is not equal to rhs, otherwise returns false.
 

Detailed Description

\inmodule QtLocation

Since
5.6

The QPlaceMatchRequest class is used to find places from one manager that match those from another. It represents a set of request parameters.

Places from another manager that may have corresponding/matching places in the current manager are assigned using setPlaces() or setResults(). A set of further parameters are specified which determines the criteria for matching.

The typical key for matching is the QPlaceMatchRequest::AlternativeId, the value is an alternative identifier attribute type of the format x_id_<provider name> for example x_id_here. The provider name is name supplied to the QGeoServiceProvider instance.

See \l {Matching places between managers} for an example on how to use a match request.

See also
QPlaceMatchReply, QPlaceManager

Definition at line 17 of file qplacematchrequest.h.

Constructor & Destructor Documentation

◆ QPlaceMatchRequest() [1/3]

QPlaceMatchRequest::QPlaceMatchRequest ( )

Default constructor.

Constructs a new request object.

Definition at line 68 of file qplacematchrequest.cpp.

◆ QPlaceMatchRequest() [2/3]

QPlaceMatchRequest::QPlaceMatchRequest ( const QPlaceMatchRequest &  other)
defaultnoexcept

Constructs a copy of other.

◆ QPlaceMatchRequest() [3/3]

QPlaceMatchRequest::QPlaceMatchRequest ( QPlaceMatchRequest &&  other)
defaultnoexcept

◆ ~QPlaceMatchRequest()

QPlaceMatchRequest::~QPlaceMatchRequest ( )
default

Destroys the request object.

Member Function Documentation

◆ clear()

void QPlaceMatchRequest::clear ( )

Clears the match request.

Definition at line 176 of file qplacematchrequest.cpp.

References d.

◆ operator=()

QPlaceMatchRequest & QPlaceMatchRequest::operator= ( const QPlaceMatchRequest &  other)
noexcept

Assigns other to this search request and returns a reference to this match request.

Definition at line 87 of file qplacematchrequest.cpp.

References other().

+ Here is the call graph for this function:

◆ parameters()

QVariantMap QPlaceMatchRequest::parameters ( ) const

Returns the parameters for matching places.

Definition at line 158 of file qplacematchrequest.cpp.

References d.

Referenced by setParameters().

+ Here is the caller graph for this function:

◆ places()

QList< QPlace > QPlaceMatchRequest::places ( ) const

Returns a list of places which are to be matched.

Definition at line 118 of file qplacematchrequest.cpp.

References d.

Referenced by setPlaces(), and setResults().

+ Here is the caller graph for this function:

◆ setParameters()

void QPlaceMatchRequest::setParameters ( const QVariantMap &  parameters)

Sets the parameters for matching places.

Definition at line 167 of file qplacematchrequest.cpp.

References d, and parameters().

+ Here is the call graph for this function:

◆ setPlaces()

void QPlaceMatchRequest::setPlaces ( const QList< QPlace > &  places)

Sets a list of places which are to be matched.

See also
setResults()

Definition at line 129 of file qplacematchrequest.cpp.

References d, and places().

+ Here is the call graph for this function:

◆ setResults()

void QPlaceMatchRequest::setResults ( const QList< QPlaceSearchResult > &  results)

Convenience function which uses a set of search results to set the places which should be matched.

See also
setPlaces()

Definition at line 141 of file qplacematchrequest.cpp.

References QList< T >::append(), d, QPlaceResult::place(), QPlaceSearchResult::PlaceResult, places(), and results.

+ Here is the call graph for this function:

◆ swap()

void QPlaceMatchRequest::swap ( QPlaceMatchRequest &  other)
inlinenoexcept

Definition at line 30 of file qplacematchrequest.h.

References other().

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ operator!=

bool QPlaceMatchRequest::operator!= ( const QPlaceMatchRequest &  lhs,
const QPlaceMatchRequest &  rhs 
)
friend

Returns true if lhs is not equal to rhs, otherwise returns false.

Definition at line 34 of file qplacematchrequest.h.

◆ operator==

bool QPlaceMatchRequest::operator== ( const QPlaceMatchRequest &  lhs,
const QPlaceMatchRequest &  rhs 
)
friend

Returns true if lhs is equal to rhs, otherwise returns false.

Definition at line 32 of file qplacematchrequest.h.

Member Data Documentation

◆ AlternativeId

const QString QPlaceMatchRequest::AlternativeId
static

\variable QPlaceMatchRequest::AlternativeId The key to specify that matching is to be accomplished via an alternative place identifier.

Definition at line 20 of file qplacematchrequest.h.

Referenced by RequestHandler::matchPlaces(), and QDeclarativeSearchResultModel::queryFinished().

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