<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qplacematchrequest.cpp -->
<title>QPlaceMatchRequest Class | Qt Location 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtlocation-index.html">Qt Location</a></td><td ><a href="qtlocation-module.html">C++ Classes</a></td><td >QPlaceMatchRequest</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtlocation-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QPlaceMatchRequest Class</h1>
<!-- $$$QPlaceMatchRequest-brief -->
<p>The <a href="qplacematchrequest.html">QPlaceMatchRequest</a> class is used to find places from one manager that match those from another. It represents a set of request parameters. <a href="#details">More...</a></p>
<!-- @@@QPlaceMatchRequest -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QPlaceMatchRequest></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += location</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.6</td></tr></table></div><ul>
<li><a href="qplacematchrequest-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#QPlaceMatchRequest">QPlaceMatchRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#QPlaceMatchRequest-1">QPlaceMatchRequest</a></b>(const QPlaceMatchRequest &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#dtor.QPlaceMatchRequest">~QPlaceMatchRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#clear">clear</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#parameters">parameters</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QPlace> </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#places">places</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#setParameters">setParameters</a></b>(const QVariantMap &<i>parameters</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#setPlaces">setPlaces</a></b>(const QList<QPlace> <i>places</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#setResults">setResults</a></b>(const QList<QPlaceSearchResult> &<i>results</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#operator-not-eq">operator!=</a></b>(const QPlaceMatchRequest &<i>other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceMatchRequest &</td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#operator-eq">operator=</a></b>(const QPlaceMatchRequest &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#operator-eq-eq">operator==</a></b>(const QPlaceMatchRequest &<i>other</i>) const</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qplacematchrequest.html#AlternativeId-var">AlternativeId</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QPlaceMatchRequest-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qplacematchrequest.html">QPlaceMatchRequest</a> class is used to find places from one manager that match those from another. It represents a set of request parameters.</p>
<p>Places from another manager that may have corresponding/matching places in the current manager are assigned using <a href="qplacematchrequest.html#setPlaces">setPlaces</a>() or <a href="qplacematchrequest.html#setResults">setResults</a>(). A set of further parameters are specified which determines the criteria for matching.</p>
<p>The typical key for matching is the <a href="qplacematchrequest.html#AlternativeId-var">QPlaceMatchRequest::AlternativeId</a>, 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 <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> instance.</p>
<p>See <a href="location-places-cpp.html#matching-places-between-managers">Matching places between managers</a> for an example on how to use a match request.</p>
</div>
<p><b>See also </b><a href="qplacematchreply.html">QPlaceMatchReply</a> and <a href="qplacemanager.html">QPlaceManager</a>.</p>
<!-- @@@QPlaceMatchRequest -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceMatchRequest[overload1]$$$QPlaceMatchRequest -->
<h3 class="fn" id="QPlaceMatchRequest"><a name="QPlaceMatchRequest"></a>QPlaceMatchRequest::<span class="name">QPlaceMatchRequest</span>()</h3>
<p>Default constructor. Constructs a new request object.</p>
<!-- @@@QPlaceMatchRequest -->
<!-- $$$QPlaceMatchRequest$$$QPlaceMatchRequestconstQPlaceMatchRequest& -->
<h3 class="fn" id="QPlaceMatchRequest-1"><a name="QPlaceMatchRequest-1"></a>QPlaceMatchRequest::<span class="name">QPlaceMatchRequest</span>(const <span class="type"><a href="qplacematchrequest.html#QPlaceMatchRequest">QPlaceMatchRequest</a></span> &<i>other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QPlaceMatchRequest -->
<!-- $$$~QPlaceMatchRequest[overload1]$$$~QPlaceMatchRequest -->
<h3 class="fn" id="dtor.QPlaceMatchRequest"><a name="dtor.QPlaceMatchRequest"></a>QPlaceMatchRequest::<span class="name">~QPlaceMatchRequest</span>()</h3>
<p>Destroys the request object.</p>
<!-- @@@~QPlaceMatchRequest -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn" id="clear"><a name="clear"></a><span class="type">void</span> QPlaceMatchRequest::<span class="name">clear</span>()</h3>
<p>Clears the match request.</p>
<!-- @@@clear -->
<!-- $$$parameters[overload1]$$$parameters -->
<h3 class="fn" id="parameters"><a name="parameters"></a><span class="type">QVariantMap</span> QPlaceMatchRequest::<span class="name">parameters</span>() const</h3>
<p>Returns the parameters for matching places.</p>
<p><b>See also </b><a href="qplacematchrequest.html#setParameters">setParameters</a>().</p>
<!-- @@@parameters -->
<!-- $$$places[overload1]$$$places -->
<h3 class="fn" id="places"><a name="places"></a><span class="type">QList</span><<span class="type"><a href="qplace.html">QPlace</a></span>> QPlaceMatchRequest::<span class="name">places</span>() const</h3>
<p>Returns a list of places which are to be matched.</p>
<p><b>See also </b><a href="qplacematchrequest.html#setPlaces">setPlaces</a>().</p>
<!-- @@@places -->
<!-- $$$setParameters[overload1]$$$setParametersconstQVariantMap& -->
<h3 class="fn" id="setParameters"><a name="setParameters"></a><span class="type">void</span> QPlaceMatchRequest::<span class="name">setParameters</span>(const <span class="type">QVariantMap</span> &<i>parameters</i>)</h3>
<p>Sets the <i>parameters</i> for matching places.</p>
<p><b>See also </b><a href="qplacematchrequest.html#parameters">parameters</a>().</p>
<!-- @@@setParameters -->
<!-- $$$setPlaces[overload1]$$$setPlacesconstQList<QPlace> -->
<h3 class="fn" id="setPlaces"><a name="setPlaces"></a><span class="type">void</span> QPlaceMatchRequest::<span class="name">setPlaces</span>(const <span class="type">QList</span><<span class="type"><a href="qplace.html">QPlace</a></span>> <i>places</i>)</h3>
<p>Sets a list of <i>places</i> which are to be matched.</p>
<p><b>See also </b><a href="qplacematchrequest.html#places">places</a>() and <a href="qplacematchrequest.html#setResults">setResults</a>().</p>
<!-- @@@setPlaces -->
<!-- $$$setResults[overload1]$$$setResultsconstQList<QPlaceSearchResult>& -->
<h3 class="fn" id="setResults"><a name="setResults"></a><span class="type">void</span> QPlaceMatchRequest::<span class="name">setResults</span>(const <span class="type">QList</span><<span class="type"><a href="qplacesearchresult.html">QPlaceSearchResult</a></span>> &<i>results</i>)</h3>
<p>Convenience function which uses a set of search <i>results</i> to set the places which should be matched.</p>
<p><b>See also </b><a href="qplacematchrequest.html#setPlaces">setPlaces</a>().</p>
<!-- @@@setResults -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceMatchRequest& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceMatchRequest::<span class="name">operator!=</span>(const <span class="type"><a href="qplacematchrequest.html#QPlaceMatchRequest">QPlaceMatchRequest</a></span> &<i>other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this match request, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceMatchRequest& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qplacematchrequest.html#QPlaceMatchRequest">QPlaceMatchRequest</a></span> &QPlaceMatchRequest::<span class="name">operator=</span>(const <span class="type"><a href="qplacematchrequest.html#QPlaceMatchRequest">QPlaceMatchRequest</a></span> &<i>other</i>)</h3>
<p>Assigns <i>other</i> to this search request and returns a reference to this match request.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceMatchRequest& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceMatchRequest::<span class="name">operator==</span>(const <span class="type"><a href="qplacematchrequest.html#QPlaceMatchRequest">QPlaceMatchRequest</a></span> &<i>other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this match request, otherwise returns false.</p>
<!-- @@@operator== -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$AlternativeId -->
<h3 class="fn" id="AlternativeId-var"><a name="AlternativeId-var"></a>const <span class="type">QString</span> QPlaceMatchRequest::<span class="name">AlternativeId</span></h3>
<p>The key to specify that matching is to be accomplished via an alternative place identifier.</p>
<!-- @@@AlternativeId -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
