<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgeoroutingmanagerengine.cpp -->
<title>Qt Mobility 1.2: QGeoRoutingManagerEngine Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtlocation.html">QtLocation</a></li>
<li>QGeoRoutingManagerEngine</li>
</ul>
</div>
</div>
<div class="content mainContent">
<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="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGeoRoutingManagerEngine Class Reference</h1>
<!-- $$$QGeoRoutingManagerEngine-brief -->
<p>The QGeoRoutingManagerEngine class provides an interface and convenience methods to implementers of <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> plugins who want to provide access to geographic routing information. <a href="#details">More...</a></p>
<!-- @@@QGeoRoutingManagerEngine -->
<pre class="cpp"> <span class="preprocessor">#include <QGeoRoutingManagerEngine></span></pre><p><b>Inherits: </b><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qgeoroutingmanagerengine-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#QGeoRoutingManagerEngine">QGeoRoutingManagerEngine</a></b> ( const QMap<QString, QVariant> & <i>parameters</i>, QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#dtor.QGeoRoutingManagerEngine">~QGeoRoutingManagerEngine</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QGeoRouteReply * </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#calculateRoute">calculateRoute</a></b> ( const QGeoRouteRequest & <i>request</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLocale </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#locale">locale</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#managerName">managerName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#managerVersion">managerVersion</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setLocale">setLocale</a></b> ( const QLocale & <i>locale</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRouteRequest::FeatureTypes </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportedFeatureTypes">supportedFeatureTypes</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRouteRequest::FeatureWeights </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportedFeatureWeights">supportedFeatureWeights</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRouteRequest::ManeuverDetails </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportedManeuverDetails">supportedManeuverDetails</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRouteRequest::RouteOptimizations </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportedRouteOptimizations">supportedRouteOptimizations</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRouteRequest::SegmentDetails </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportedSegmentDetails">supportedSegmentDetails</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRouteRequest::TravelModes </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportedTravelModes">supportedTravelModes</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportsAlternativeRoutes">supportsAlternativeRoutes</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportsExcludeAreas">supportsExcludeAreas</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#supportsRouteUpdates">supportsRouteUpdates</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QGeoRouteReply * </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#updateRoute">updateRoute</a></b> ( const QGeoRoute & <i>route</i>, const QGeoCoordinate & <i>position</i> )</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#error">error</a></b> ( QGeoRouteReply * <i>reply</i>, QGeoRouteReply::Error <i>error</i>, QString <i>errorString</i> = QString() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#finished">finished</a></b> ( QGeoRouteReply * <i>reply</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportedFeatureTypes">setSupportedFeatureTypes</a></b> ( QGeoRouteRequest::FeatureTypes <i>featureTypes</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportedFeatureWeights">setSupportedFeatureWeights</a></b> ( QGeoRouteRequest::FeatureWeights <i>featureWeights</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportedManeuverDetails">setSupportedManeuverDetails</a></b> ( QGeoRouteRequest::ManeuverDetails <i>maneuverDetails</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportedRouteOptimizations">setSupportedRouteOptimizations</a></b> ( QGeoRouteRequest::RouteOptimizations <i>optimizations</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportedSegmentDetails">setSupportedSegmentDetails</a></b> ( QGeoRouteRequest::SegmentDetails <i>segmentDetails</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportedTravelModes">setSupportedTravelModes</a></b> ( QGeoRouteRequest::TravelModes <i>travelModes</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportsAlternativeRoutes">setSupportsAlternativeRoutes</a></b> ( bool <i>supported</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportsExcludeAreas">setSupportsExcludeAreas</a></b> ( bool <i>supported</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeoroutingmanagerengine.html#setSupportsRouteUpdates">setSupportsRouteUpdates</a></b> ( bool <i>supported</i> )</td></tr>
</table>
<ul>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QGeoRoutingManagerEngine-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoRoutingManagerEngine class provides an interface and convenience methods to implementers of <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> plugins who want to provide access to geographic routing information.</p>
<p>Subclasses of QGeoRoutingManagerEngine need to provide an implementation of <a href="qgeoroutingmanagerengine.html#calculateRoute">calculateRoute</a>().</p>
<p>In the default implementation, <a href="qgeoroutingmanagerengine.html#supportsRouteUpdates">supportsRouteUpdates</a>() returns false and <a href="qgeoroutingmanagerengine.html#updateRoute">updateRoute</a>() returns a <a href="qgeoroutereply.html">QGeoRouteReply</a> object containing a <a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::UnsupportedOptionError</a>.</p>
<p>If the routing service supports updating routes as they are being travelled, the subclass should provide an implementation of <a href="qgeoroutingmanagerengine.html#updateRoute">updateRoute</a>() and call setSupportsRouteUpdates(true) at some point in time before <a href="qgeoroutingmanagerengine.html#updateRoute">updateRoute</a>() is called.</p>
<p>The function <a href="qgeoroutingmanagerengine.html#setSupportsRouteUpdates">setSupportsRouteUpdates</a>() is one of several functions which configure the reported capabilities of the engine. If the capabilities of an engine differ from the default values these functions should be used so that the reported capabilies are accurate.</p>
<p>It is important that this is done before <a href="qgeoroutingmanagerengine.html#calculateRoute">calculateRoute</a>(), <a href="qgeoroutingmanagerengine.html#updateRoute">updateRoute</a>() or any of the capability reporting functions are used to prevent incorrect or inconsistent behaviour.</p>
<p>A subclass of QGeoRouteManagerEngine will often make use of a subclass fo <a href="qgeoroutereply.html">QGeoRouteReply</a> internally, in order to add any engine-specific data (such as a <a href="http://qt.nokia.com/doc/4.7/qnetworkreply.html">QNetworkReply</a> object for network-based services) to the <a href="qgeoroutereply.html">QGeoRouteReply</a> instances used by the engine.</p>
</div>
<p><b>See also </b><a href="qgeoroutingmanager.html">QGeoRoutingManager</a>.</p>
<!-- @@@QGeoRoutingManagerEngine -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoRoutingManagerEngine[overload1]$$$QGeoRoutingManagerEngineconstQMap<QString,QVariant>&QObject* -->
<h3 class="fn"><a name="QGeoRoutingManagerEngine"></a>QGeoRoutingManagerEngine::<span class="name">QGeoRoutingManagerEngine</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qmap.html">QMap</a></span><<span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span>> & <i>parameters</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a new engine with the specified <i>parent</i>, using <i>parameters</i> to pass any implementation specific data to the engine.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QGeoRoutingManagerEngine -->
<!-- $$$~QGeoRoutingManagerEngine[overload1]$$$~QGeoRoutingManagerEngine -->
<h3 class="fn"><a name="dtor.QGeoRoutingManagerEngine"></a>QGeoRoutingManagerEngine::<span class="name">~QGeoRoutingManagerEngine</span> ()<tt> [virtual]</tt></h3>
<p>Destroys this engine.</p>
<!-- @@@~QGeoRoutingManagerEngine -->
<!-- $$$calculateRoute[overload1]$$$calculateRouteconstQGeoRouteRequest& -->
<h3 class="fn"><a name="calculateRoute"></a><span class="type"><a href="qgeoroutereply.html">QGeoRouteReply</a></span> * QGeoRoutingManagerEngine::<span class="name">calculateRoute</span> ( const <span class="type"><a href="qgeorouterequest.html">QGeoRouteRequest</a></span> & <i>request</i> )<tt> [pure virtual]</tt></h3>
<p>Begins the calculation of the route specified by <i>request</i>.</p>
<p>A <a href="qgeoroutereply.html">QGeoRouteReply</a> object will be returned, which can be used to manage the routing operation and to return the results of the operation.</p>
<p>This engine and the returned <a href="qgeoroutereply.html">QGeoRouteReply</a> object will emit signals indicating if the operation completes or if errors occur.</p>
<p>Once the operation has completed, QGeoRouteReply::routes can be used to retrieve the calculated route or routes.</p>
<p>If <i>request</i> includes features which are not supported by this engine, as reported by the methods in this engine, then a <a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::UnsupportedOptionError</a> will occur.</p>
<p>The user is responsible for deleting the returned reply object, although this can be done in the slot connected to <a href="qgeoroutingmanagerengine.html#finished">QGeoRoutingManagerEngine::finished</a>(), <a href="qgeoroutingmanagerengine.html#error">QGeoRoutingManagerEngine::error</a>(), <a href="qgeoroutereply.html#finished">QGeoRouteReply::finished</a>() or <a href="qgeoroutereply.html#error">QGeoRouteReply::error</a>() with <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@calculateRoute -->
<!-- $$$error[overload1]$$$errorQGeoRouteReply*QGeoRouteReply::ErrorQString -->
<h3 class="fn"><a name="error"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">error</span> ( <span class="type"><a href="qgeoroutereply.html">QGeoRouteReply</a></span> * <i>reply</i>, <span class="type"><a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::Error</a></span> <i>error</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> <i>errorString</i> = QString() )<tt> [signal]</tt></h3>
<p>This signal is emitted when an error has been detected in the processing of <i>reply</i>. The <a href="qgeoroutingmanagerengine.html#finished">QGeoRoutingManagerEngine::finished</a>() signal will probably follow.</p>
<p>The error will be described by the error code <i>error</i>. If <i>errorString</i> is not empty it will contain a textual description of the error.</p>
<p>This signal and <a href="qgeoroutereply.html#error">QGeoRouteReply::error</a>() will be emitted at the same time.</p>
<p><b>Note:</b> Do no delete the <i>reply</i> object in the slot connected to this signal. Use <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>() instead.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@error -->
<!-- $$$finished[overload1]$$$finishedQGeoRouteReply* -->
<h3 class="fn"><a name="finished"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">finished</span> ( <span class="type"><a href="qgeoroutereply.html">QGeoRouteReply</a></span> * <i>reply</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when <i>reply</i> has finished processing.</p>
<p>If reply::error() equals <a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::NoError</a> then the processing finished successfully.</p>
<p>This signal and <a href="qgeoroutereply.html#finished">QGeoRouteReply::finished</a>() will be emitted at the same time.</p>
<p><b>Note:</b> Do no delete the <i>reply</i> object in the slot connected to this signal. Use <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>() instead.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@finished -->
<!-- $$$locale[overload1]$$$locale -->
<h3 class="fn"><a name="locale"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlocale.html">QLocale</a></span> QGeoRoutingManagerEngine::<span class="name">locale</span> () const</h3>
<p>Returns the locale used to hint to this routing manager about what language to use for addresses and instructions.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setLocale">setLocale</a>().</p>
<!-- @@@locale -->
<!-- $$$managerName[overload1]$$$managerName -->
<h3 class="fn"><a name="managerName"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QGeoRoutingManagerEngine::<span class="name">managerName</span> () const</h3>
<p>Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.</p>
<p>The combination of managerName() and <a href="qgeoroutingmanagerengine.html#managerVersion">managerVersion</a>() should be unique amongst plugin implementations.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@managerName -->
<!-- $$$managerVersion[overload1]$$$managerVersion -->
<h3 class="fn"><a name="managerVersion"></a><span class="type">int</span> QGeoRoutingManagerEngine::<span class="name">managerVersion</span> () const</h3>
<p>Returns the version of this engine implementation.</p>
<p>The combination of <a href="qgeoroutingmanagerengine.html#managerName">managerName</a>() and managerVersion() should be unique amongst plugin implementations.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@managerVersion -->
<!-- $$$setLocale[overload1]$$$setLocaleconstQLocale& -->
<h3 class="fn"><a name="setLocale"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setLocale</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qlocale.html">QLocale</a></span> & <i>locale</i> )</h3>
<p>Sets the locale to be used by the this manager to <i>locale</i>.</p>
<p>If this routing manager supports returning addresses and instructions in different languages, they will be returned in the language of <i>locale</i>.</p>
<p>The locale used defaults to the system locale if this is not set.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#locale">locale</a>().</p>
<!-- @@@setLocale -->
<!-- $$$setSupportedFeatureTypes[overload1]$$$setSupportedFeatureTypesQGeoRouteRequest::FeatureTypes -->
<h3 class="fn"><a name="setSupportedFeatureTypes"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportedFeatureTypes</span> ( <span class="type"><a href="qgeorouterequest.html#FeatureType-enum">QGeoRouteRequest::FeatureTypes</a></span> <i>featureTypes</i> )<tt> [protected]</tt></h3>
<p>Sets the types of features that this engine can take into account during route planning to <i>featureTypes</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no feature types at all.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportedFeatureTypes">supportedFeatureTypes</a>().</p>
<!-- @@@setSupportedFeatureTypes -->
<!-- $$$setSupportedFeatureWeights[overload1]$$$setSupportedFeatureWeightsQGeoRouteRequest::FeatureWeights -->
<h3 class="fn"><a name="setSupportedFeatureWeights"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportedFeatureWeights</span> ( <span class="type"><a href="qgeorouterequest.html#FeatureWeight-enum">QGeoRouteRequest::FeatureWeights</a></span> <i>featureWeights</i> )<tt> [protected]</tt></h3>
<p>Sets the weightings which this engine can apply to different features during route planning to <i>featureWeights</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no feaure weights at all.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportedFeatureWeights">supportedFeatureWeights</a>().</p>
<!-- @@@setSupportedFeatureWeights -->
<!-- $$$setSupportedManeuverDetails[overload1]$$$setSupportedManeuverDetailsQGeoRouteRequest::ManeuverDetails -->
<h3 class="fn"><a name="setSupportedManeuverDetails"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportedManeuverDetails</span> ( <span class="type"><a href="qgeorouterequest.html#ManeuverDetail-enum">QGeoRouteRequest::ManeuverDetails</a></span> <i>maneuverDetails</i> )<tt> [protected]</tt></h3>
<p>Sets the levels of detail for navigation manuevers which can be requested by this engine to <i>maneuverDetails</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no maneuver details at all.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportedManeuverDetails">supportedManeuverDetails</a>().</p>
<!-- @@@setSupportedManeuverDetails -->
<!-- $$$setSupportedRouteOptimizations[overload1]$$$setSupportedRouteOptimizationsQGeoRouteRequest::RouteOptimizations -->
<h3 class="fn"><a name="setSupportedRouteOptimizations"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportedRouteOptimizations</span> ( <span class="type"><a href="qgeorouterequest.html#RouteOptimization-enum">QGeoRouteRequest::RouteOptimizations</a></span> <i>optimizations</i> )<tt> [protected]</tt></h3>
<p>Sets the route optimizations supported by this engine to <i>optimizations</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no route optimizations at all.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportedRouteOptimizations">supportedRouteOptimizations</a>().</p>
<!-- @@@setSupportedRouteOptimizations -->
<!-- $$$setSupportedSegmentDetails[overload1]$$$setSupportedSegmentDetailsQGeoRouteRequest::SegmentDetails -->
<h3 class="fn"><a name="setSupportedSegmentDetails"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportedSegmentDetails</span> ( <span class="type"><a href="qgeorouterequest.html#SegmentDetail-enum">QGeoRouteRequest::SegmentDetails</a></span> <i>segmentDetails</i> )<tt> [protected]</tt></h3>
<p>Sets the levels of detail for routing segments which can be requested by this engine to <i>segmentDetails</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no segment detail at all.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportedSegmentDetails">supportedSegmentDetails</a>().</p>
<!-- @@@setSupportedSegmentDetails -->
<!-- $$$setSupportedTravelModes[overload1]$$$setSupportedTravelModesQGeoRouteRequest::TravelModes -->
<h3 class="fn"><a name="setSupportedTravelModes"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportedTravelModes</span> ( <span class="type"><a href="qgeorouterequest.html#TravelMode-enum">QGeoRouteRequest::TravelModes</a></span> <i>travelModes</i> )<tt> [protected]</tt></h3>
<p>Sets the travel modes supported by this engine to <i>travelModes</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no travel modes at all.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportedTravelModes">supportedTravelModes</a>().</p>
<!-- @@@setSupportedTravelModes -->
<!-- $$$setSupportsAlternativeRoutes[overload1]$$$setSupportsAlternativeRoutesbool -->
<h3 class="fn"><a name="setSupportsAlternativeRoutes"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportsAlternativeRoutes</span> ( <span class="type">bool</span> <i>supported</i> )<tt> [protected]</tt></h3>
<p>Sets whether this engine supports request for alternative routes to <i>supported</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support alternative routes.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportsAlternativeRoutes">supportsAlternativeRoutes</a>().</p>
<!-- @@@setSupportsAlternativeRoutes -->
<!-- $$$setSupportsExcludeAreas[overload1]$$$setSupportsExcludeAreasbool -->
<h3 class="fn"><a name="setSupportsExcludeAreas"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportsExcludeAreas</span> ( <span class="type">bool</span> <i>supported</i> )<tt> [protected]</tt></h3>
<p>Sets whether this engine supports request for excluding areas from routes to <i>supported</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support excluding areas.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportsExcludeAreas">supportsExcludeAreas</a>().</p>
<!-- @@@setSupportsExcludeAreas -->
<!-- $$$setSupportsRouteUpdates[overload1]$$$setSupportsRouteUpdatesbool -->
<h3 class="fn"><a name="setSupportsRouteUpdates"></a><span class="type">void</span> QGeoRoutingManagerEngine::<span class="name">setSupportsRouteUpdates</span> ( <span class="type">bool</span> <i>supported</i> )<tt> [protected]</tt></h3>
<p>Sets whether this engine supports updating routes to <i>supported</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support updating routes.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#supportsRouteUpdates">supportsRouteUpdates</a>().</p>
<!-- @@@setSupportsRouteUpdates -->
<!-- $$$supportedFeatureTypes[overload1]$$$supportedFeatureTypes -->
<h3 class="fn"><a name="supportedFeatureTypes"></a><span class="type"><a href="qgeorouterequest.html#FeatureType-enum">QGeoRouteRequest::FeatureTypes</a></span> QGeoRoutingManagerEngine::<span class="name">supportedFeatureTypes</span> () const</h3>
<p>Returns the types of features that this engine can take into account during route planning.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportedFeatureTypes">setSupportedFeatureTypes</a>().</p>
<!-- @@@supportedFeatureTypes -->
<!-- $$$supportedFeatureWeights[overload1]$$$supportedFeatureWeights -->
<h3 class="fn"><a name="supportedFeatureWeights"></a><span class="type"><a href="qgeorouterequest.html#FeatureWeight-enum">QGeoRouteRequest::FeatureWeights</a></span> QGeoRoutingManagerEngine::<span class="name">supportedFeatureWeights</span> () const</h3>
<p>Returns the weightings which this engine can apply to different features during route planning.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportedFeatureWeights">setSupportedFeatureWeights</a>().</p>
<!-- @@@supportedFeatureWeights -->
<!-- $$$supportedManeuverDetails[overload1]$$$supportedManeuverDetails -->
<h3 class="fn"><a name="supportedManeuverDetails"></a><span class="type"><a href="qgeorouterequest.html#ManeuverDetail-enum">QGeoRouteRequest::ManeuverDetails</a></span> QGeoRoutingManagerEngine::<span class="name">supportedManeuverDetails</span> () const</h3>
<p>Returns the levels of detail for navigation maneuvers which can be requested by this engine.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportedManeuverDetails">setSupportedManeuverDetails</a>().</p>
<!-- @@@supportedManeuverDetails -->
<!-- $$$supportedRouteOptimizations[overload1]$$$supportedRouteOptimizations -->
<h3 class="fn"><a name="supportedRouteOptimizations"></a><span class="type"><a href="qgeorouterequest.html#RouteOptimization-enum">QGeoRouteRequest::RouteOptimizations</a></span> QGeoRoutingManagerEngine::<span class="name">supportedRouteOptimizations</span> () const</h3>
<p>Returns the route optimizations supported by this engine.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportedRouteOptimizations">setSupportedRouteOptimizations</a>().</p>
<!-- @@@supportedRouteOptimizations -->
<!-- $$$supportedSegmentDetails[overload1]$$$supportedSegmentDetails -->
<h3 class="fn"><a name="supportedSegmentDetails"></a><span class="type"><a href="qgeorouterequest.html#SegmentDetail-enum">QGeoRouteRequest::SegmentDetails</a></span> QGeoRoutingManagerEngine::<span class="name">supportedSegmentDetails</span> () const</h3>
<p>Returns the levels of detail for routing segments which can be requested by this engine.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportedSegmentDetails">setSupportedSegmentDetails</a>().</p>
<!-- @@@supportedSegmentDetails -->
<!-- $$$supportedTravelModes[overload1]$$$supportedTravelModes -->
<h3 class="fn"><a name="supportedTravelModes"></a><span class="type"><a href="qgeorouterequest.html#TravelMode-enum">QGeoRouteRequest::TravelModes</a></span> QGeoRoutingManagerEngine::<span class="name">supportedTravelModes</span> () const</h3>
<p>Returns the travel modes supported by this engine.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportedTravelModes">setSupportedTravelModes</a>().</p>
<!-- @@@supportedTravelModes -->
<!-- $$$supportsAlternativeRoutes[overload1]$$$supportsAlternativeRoutes -->
<h3 class="fn"><a name="supportsAlternativeRoutes"></a><span class="type">bool</span> QGeoRoutingManagerEngine::<span class="name">supportsAlternativeRoutes</span> () const</h3>
<p>Returns whether this engine supports request for alternative routes.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportsAlternativeRoutes">setSupportsAlternativeRoutes</a>().</p>
<!-- @@@supportsAlternativeRoutes -->
<!-- $$$supportsExcludeAreas[overload1]$$$supportsExcludeAreas -->
<h3 class="fn"><a name="supportsExcludeAreas"></a><span class="type">bool</span> QGeoRoutingManagerEngine::<span class="name">supportsExcludeAreas</span> () const</h3>
<p>Returns whether this engine supports the exclusion of areas from routes.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportsExcludeAreas">setSupportsExcludeAreas</a>().</p>
<!-- @@@supportsExcludeAreas -->
<!-- $$$supportsRouteUpdates[overload1]$$$supportsRouteUpdates -->
<h3 class="fn"><a name="supportsRouteUpdates"></a><span class="type">bool</span> QGeoRoutingManagerEngine::<span class="name">supportsRouteUpdates</span> () const</h3>
<p>Returns whether this engine supports updating routes.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeoroutingmanagerengine.html#setSupportsRouteUpdates">setSupportsRouteUpdates</a>().</p>
<!-- @@@supportsRouteUpdates -->
<!-- $$$updateRoute[overload1]$$$updateRouteconstQGeoRoute&constQGeoCoordinate& -->
<h3 class="fn"><a name="updateRoute"></a><span class="type"><a href="qgeoroutereply.html">QGeoRouteReply</a></span> * QGeoRoutingManagerEngine::<span class="name">updateRoute</span> ( const <span class="type"><a href="qgeoroute.html">QGeoRoute</a></span> & <i>route</i>, const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> & <i>position</i> )<tt> [virtual]</tt></h3>
<p>Begins the process of updating <i>route</i> based on the current position <i>position</i>.</p>
<p>A <a href="qgeoroutereply.html">QGeoRouteReply</a> object will be returned, which can be used to manage the routing operation and to return the results of the operation.</p>
<p>This engine and the returned <a href="qgeoroutereply.html">QGeoRouteReply</a> object will emit signals indicating if the operation completes or if errors occur.</p>
<p>If <a href="qgeoroutingmanagerengine.html#supportsRouteUpdates">supportsRouteUpdates</a>() returns false an <a href="qgeoroutereply.html#Error-enum">QGeoRouteReply::UnsupportedOptionError</a> will occur.</p>
<p>Once the operation has completed, QGeoRouteReply::routes can be used to retrieve the updated route.</p>
<p>The returned route could be entirely different to the original route, especially if <i>position</i> is far enough away from the initial route. Otherwise the route will be similar, although the remaining time and distance will be updated and any segments of the original route which have been traversed will be removed.</p>
<p>The user is responsible for deleting the returned reply object, although this can be done in the slot connected to <a href="qgeoroutingmanagerengine.html#finished">QGeoRoutingManagerEngine::finished</a>(), <a href="qgeoroutingmanagerengine.html#error">QGeoRoutingManagerEngine::error</a>(), <a href="qgeoroutereply.html#finished">QGeoRouteReply::finished</a>() or <a href="qgeoroutereply.html#error">QGeoRouteReply::error</a>() with <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@updateRoute -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used 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.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
918
