QGeoRouteRequest Class Reference
The QGeoRouteRequest class represents the parameters and restrictions which define a request for routing information. More...
#include <QGeoRouteRequest>
Public Types
enum | AvoidFeatureType { AvoidNothing, AvoidTolls, AvoidHighways, AvoidPublicTransit, ..., AvoidMotorPoolLanes } |
flags | AvoidFeatureTypes |
enum | InstructionDetail { NoInstructions, BasicInstructions } |
flags | InstructionDetails |
enum | RouteOptimization { ShortestRoute, FastestRoute, MostEconomicRoute, MostScenicRoute } |
flags | RouteOptimizations |
enum | SegmentDetail { NoSegmentData, BasicSegmentData } |
flags | SegmentDetails |
enum | TravelMode { CarTravel, PedestrianTravel, BicycleTravel, PublicTransitTravel, TruckTravel } |
flags | TravelModes |
Public Functions
Detailed Description
The QGeoRouteRequest class represents the parameters and restrictions which define a request for routing information.
The default state of a QGeoRouteRequest instance will result in a request for basic route segment and navigation instructions describing the fastest route by car which covers the given waypoints.
There may be signifcant variation in the features supported by different providers of routing information, or even in the features supported by the same provider if different levels of authorization are used.
There are several functions in QGeoRoutingManager which can be used to check which features are supported with the current provider and authorization level.
See also QGeoRoutingManager.
Member Type Documentation
enum QGeoRouteRequest::AvoidFeatureType
flags QGeoRouteRequest::AvoidFeatureTypes
Defines features to be avoided while planning a route.
|
Constant | Value | Description |
QGeoRouteRequest::AvoidNothing | 0x00000000 | The route can be planned without considering features to be avoided. |
QGeoRouteRequest::AvoidTolls | 0x00000001 | Avoid routes that require the use of tollways. |
QGeoRouteRequest::AvoidHighways | 0x00000002 | Avoid routes that require the use of highways. |
QGeoRouteRequest::AvoidPublicTransit | 0x00000004 | Avoid routes that require the use of public transit. |
QGeoRouteRequest::AvoidFerries | 0x00000008 | Avoid routes that require the use of ferries. |
QGeoRouteRequest::AvoidTunnels | 0x00000010 | Avoid routes that require the use of tunnels. |
QGeoRouteRequest::AvoidDirtRoads | 0x00000020 | Avoid routes that require the use of dirt roads. |
QGeoRouteRequest::AvoidPark | 0x00000040 | Avoid routes that require the travel through parks. |
QGeoRouteRequest::AvoidMotorPoolLanes | 0x00000080 | Avoid routes that require the use of motor pool lanes. |
The AvoidFeatureTypes type is a typedef for QFlags<AvoidFeatureType>. It stores an OR combination of AvoidFeatureType values.
enum QGeoRouteRequest::InstructionDetail
flags QGeoRouteRequest::InstructionDetails
Defines the amount of instruction information that should be included with the route.
|
Constant | Value | Description |
QGeoRouteRequest::NoInstructions | 0x0000 | No instructions should be included with the route. |
QGeoRouteRequest::BasicInstructions | 0x0001 | Basic instructions will be included with the route. This will include QGeoNavigationInstruction::instructionText(). |
The InstructionDetails type is a typedef for QFlags<InstructionDetail>. It stores an OR combination of InstructionDetail values.
enum QGeoRouteRequest::RouteOptimization
flags QGeoRouteRequest::RouteOptimizations
Defines the type of optimization which is applied to the planning of the route.
|
Constant | Value | Description |
QGeoRouteRequest::ShortestRoute | 0x0001 | Minimize the length of the journey. |
QGeoRouteRequest::FastestRoute | 0x0002 | Minimize the travelling time for the journey. |
QGeoRouteRequest::MostEconomicRoute | 0x0004 | Minimize the cost of the journey. |
QGeoRouteRequest::MostScenicRoute | 0x0008 | Maximize the scenic potential of the journey. |
The RouteOptimizations type is a typedef for QFlags<RouteOptimization>. It stores an OR combination of RouteOptimization values.
enum QGeoRouteRequest::SegmentDetail
flags QGeoRouteRequest::SegmentDetails
Defines the amount of route segment information that shoudl be included with the route.
|
Constant | Value | Description |
QGeoRouteRequest::NoSegmentData | 0x0000 | No segment data should be included with the route. A route requested with this level of segment detail will initialise QGeoRouteSegment::path() as a straight line between the positions of the previous and next QGeoNavigationInstructions. |
QGeoRouteRequest::BasicSegmentData | 0x0001 | Basic segment data will be included with the route. This will include QGeoRouteSegment::path(). |
The SegmentDetails type is a typedef for QFlags<SegmentDetail>. It stores an OR combination of SegmentDetail values.
enum QGeoRouteRequest::TravelMode
flags QGeoRouteRequest::TravelModes
Defines modes of travel to be used for a route.
|
Constant | Value | Description |
QGeoRouteRequest::CarTravel | 0x0001 | The route will be optimized for someone who is driving a car. |
QGeoRouteRequest::PedestrianTravel | 0x0002 | The route will be optimized for someone who is walking. |
QGeoRouteRequest::BicycleTravel | 0x0004 | The route will be optimized for someone who is riding a bicycle. |
QGeoRouteRequest::PublicTransitTravel | 0x0008 | The route will be optimized for someone who is making use of public transit. |
QGeoRouteRequest::TruckTravel | 0x0010 | The route will be optimized for someone who is driving a truck. |
The TravelModes type is a typedef for QFlags<TravelMode>. It stores an OR combination of TravelMode values.
Member Function Documentation
QGeoRouteRequest::QGeoRouteRequest ( const QList<QGeoCoordinate> & waypoints = QList<QGeoCoordinate> () )
Constructs a request to calculate a route through the coordinates waypoints.
The route will traverse the elements of waypoints in order.
QGeoRouteRequest::QGeoRouteRequest ( const QGeoCoordinate & origin, const QGeoCoordinate & destination )
Constructs a request to calculate a route between origin and destination.
QGeoRouteRequest::QGeoRouteRequest ( const QGeoRouteRequest & other )
Constructs a route request object from the contents of other.
QGeoRouteRequest::~QGeoRouteRequest ()
Destroys the request.
AvoidFeatureTypes QGeoRouteRequest::avoidFeatureTypes () const
Returns the features which this request specifies should be avoided during the planning of the route.
See also setAvoidFeatureTypes().
QList<QGeoBoundingBox> QGeoRouteRequest::excludeAreas () const
Returns areas the route must not cross.
See also setExcludeAreas().
InstructionDetail QGeoRouteRequest::instructionDetail () const
Returns the level of detail which will be used in the representation of routing instructions.
See also setInstructionDetail().
int QGeoRouteRequest::numberAlternativeRoutes () const
Returns the number of alternative routes which will be requested.
See also setNumberAlternativeRoutes().
RouteOptimizations QGeoRouteRequest::routeOptimization () const
Returns the optimization criteria which this request specifies should be used while planning the route.
See also setRouteOptimization().
SegmentDetail QGeoRouteRequest::segmentDetail () const
Returns the level of detail which will be used in the representation of routing segments.
See also setSegmentDetail().
void QGeoRouteRequest::setAvoidFeatureTypes ( AvoidFeatureTypes avoidFeatureTypes )
Sets the features to be avoided during the planning of the route to avoidFeatureTypes.
The default value is QGeoRouteRequest::AvoidNothing.
See also avoidFeatureTypes().
void QGeoRouteRequest::setExcludeAreas ( const QList<QGeoBoundingBox> & areas )
Sets areas as excluded areas that the route must not cross.
See also excludeAreas().
void QGeoRouteRequest::setInstructionDetail ( InstructionDetail instructionDetail )
Sets the level of detail to use when representing routing instructions to instructionDetail.
The default value is QGeoRouteRequest::BasicInstructions.
See also instructionDetail().
void QGeoRouteRequest::setNumberAlternativeRoutes ( int alternatives )
Sets the number of alternative routes to request to alternatives.
The default value is 0.
See also numberAlternativeRoutes().
void QGeoRouteRequest::setRouteOptimization ( RouteOptimizations optimization )
Sets the optimization criteria to use while planning the route to optimization.
The default value is QGeoRouteRequest::FastestRoute.
See also routeOptimization().
void QGeoRouteRequest::setSegmentDetail ( SegmentDetail segmentDetail )
Sets the level of detail to use when representing routing segments to segmentDetail.
See also segmentDetail().
void QGeoRouteRequest::setTravelModes ( TravelModes travelModes )
Sets the travel modes which should be considered during the planning of the route to travelModes.
The default value is QGeoRouteRequest::CarTravel.
See also travelModes().
void QGeoRouteRequest::setWaypoints ( const QList<QGeoCoordinate> & waypoints )
Sets waypoints as the waypoints that the route should pass through.
The waypoints should be given in order from origin to destination.
This request will be invalid until the waypoints have been set to a list containing two or more coordinates.
See also waypoints().
TravelModes QGeoRouteRequest::travelModes () const
Returns the travel modes which this request specifies should be considered during the planning of the route.
See also setTravelModes().
QList<QGeoCoordinate> QGeoRouteRequest::waypoints () const
Returns the waypoints that the route will pass through.
See also setWaypoints().
QGeoRouteRequest & QGeoRouteRequest::operator= ( const QGeoRouteRequest & other )
Assigns other to this route request object and then returns a reference to this route request object.