1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtLocation module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL3$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPLv3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or later as published by the Free
28 ** Software Foundation and appearing in the file LICENSE.GPL included in
29 ** the packaging of this file. Please review the following information to
30 ** ensure the GNU General Public License version 2.0 requirements will be
31 ** met: http://www.gnu.org/licenses/gpl-2.0.html.
32 **
33 ** $QT_END_LICENSE$
34 **
35 ****************************************************************************/
36 
37 #ifndef QGEOROUTINGMANAGERENGINE_H
38 #define QGEOROUTINGMANAGERENGINE_H
39 
40 #include <QtCore/QObject>
41 #include <QtCore/QMap>
42 #include <QtCore/QLocale>
43 #include <QtLocation/QGeoRouteRequest>
44 #include <QtLocation/QGeoRouteReply>
45 
46 QT_BEGIN_NAMESPACE
47 
48 class QGeoRoutingManagerEnginePrivate;
49 
50 class Q_LOCATION_EXPORT QGeoRoutingManagerEngine : public QObject
51 {
52     Q_OBJECT
53 public:
54     explicit QGeoRoutingManagerEngine(const QVariantMap &parameters, QObject *parent = nullptr);
55     virtual ~QGeoRoutingManagerEngine();
56 
57     QString managerName() const;
58     int managerVersion() const;
59 
60     virtual QGeoRouteReply *calculateRoute(const QGeoRouteRequest &request) = 0;
61     virtual QGeoRouteReply *updateRoute(const QGeoRoute &route, const QGeoCoordinate &position);
62 
63     QGeoRouteRequest::TravelModes supportedTravelModes() const;
64     QGeoRouteRequest::FeatureTypes supportedFeatureTypes() const;
65     QGeoRouteRequest::FeatureWeights supportedFeatureWeights() const;
66     QGeoRouteRequest::RouteOptimizations supportedRouteOptimizations() const;
67     QGeoRouteRequest::SegmentDetails supportedSegmentDetails() const;
68     QGeoRouteRequest::ManeuverDetails supportedManeuverDetails() const;
69 
70     void setLocale(const QLocale &locale);
71     QLocale locale() const;
72     void setMeasurementSystem(QLocale::MeasurementSystem system);
73     QLocale::MeasurementSystem measurementSystem() const;
74 
75 Q_SIGNALS:
76     void finished(QGeoRouteReply *reply);
77     void error(QGeoRouteReply *reply, QGeoRouteReply::Error error, QString errorString = QString());
78 
79 protected:
80     void setSupportedTravelModes(QGeoRouteRequest::TravelModes travelModes);
81     void setSupportedFeatureTypes(QGeoRouteRequest::FeatureTypes featureTypes);
82     void setSupportedFeatureWeights(QGeoRouteRequest::FeatureWeights featureWeights);
83     void setSupportedRouteOptimizations(QGeoRouteRequest::RouteOptimizations optimizations);
84     void setSupportedSegmentDetails(QGeoRouteRequest::SegmentDetails segmentDetails);
85     void setSupportedManeuverDetails(QGeoRouteRequest::ManeuverDetails maneuverDetails);
86 
87 private:
88     void setManagerName(const QString &managerName);
89     void setManagerVersion(int managerVersion);
90 
91     QGeoRoutingManagerEnginePrivate *d_ptr;
92     Q_DISABLE_COPY(QGeoRoutingManagerEngine)
93 
94     friend class QGeoServiceProvider;
95     friend class QGeoServiceProviderPrivate;
96 };
97 
98 QT_END_NAMESPACE
99 
100 #endif
101