QGeoRoute Class Reference

 #include <QGeoRoute>

Member Function Documentation

QGeoRoute::QGeoRoute ()

Constructs a route object.

QGeoRoute::QGeoRoute ( const QGeoRoute & other )

Constructs a route object from the contents of other.

QGeoRoute::~QGeoRoute ()

Destroys this route object.

QGeoBoundingBox QGeoRoute::bounds () const

Returns a bounding box which encompasses the entire route.

This function was introduced in Qt Mobility 1.1.

See also setBounds().

qreal QGeoRoute::distance () const

Returns the distance covered by this route, in metres.

This function was introduced in Qt Mobility 1.1.

See also setDistance().

QGeoRouteSegment QGeoRoute::firstRouteSegment () const

Returns the first route segment in the route.

Will return an invalid route segment if there are no route segments associated with the route.

The remaining route segments can be accessed sequentially with QGeoRouteSegment::nextRouteSegment.

This function was introduced in Qt Mobility 1.1.

See also setFirstRouteSegment().

QList<QGeoCoordinate> QGeoRoute::path () const

Returns the geometric shape of the route.

The coordinates should be listed in the order in which they would be traversed by someone traveling along this segment of the route.

This function was introduced in Qt Mobility 1.1.

See also setPath().

QGeoRouteRequest QGeoRoute::request () const

Returns the route request which describes the criteria used in the calculation of this route.

This function was introduced in Qt Mobility 1.1.

See also setRequest().

QString QGeoRoute::routeId () const

Returns the ID of this route.

Service providers which support the updating of routes commonly assign IDs to routes. If this route did not come from such a service provider the function will return an empty string.

This function was introduced in Qt Mobility 1.1.

See also setRouteId().

void QGeoRoute::setBounds ( const QGeoBoundingBox & bounds )

Sets the bounding box which encompasses the entire route to bounds.

This function was introduced in Qt Mobility 1.1.

See also bounds().

void QGeoRoute::setDistance ( qreal distance )

Sets the distance covered by this route, in metres, to distance.

This function was introduced in Qt Mobility 1.1.

See also distance().

void QGeoRoute::setFirstRouteSegment ( const QGeoRouteSegment & routeSegment )

Sets the first route segment in the route to routeSegment.

This function was introduced in Qt Mobility 1.1.

See also firstRouteSegment().

void QGeoRoute::setPath ( const QList<QGeoCoordinate> & path )

Sets the geometric shape of the route to path.

The coordinates in path should be listed in the order in which they would be traversed by someone traveling along this segment of the route.

This function was introduced in Qt Mobility 1.1.

See also path().

void QGeoRoute::setRequest ( const QGeoRouteRequest & request )

Sets the route request which describes the criteria used in the calculcation of this route to request.

See also request().

void QGeoRoute::setRouteId ( const QString & id )

Sets the ID of this route to id.

Service providers which support the updating of routes commonly assign IDs to routes. If this route came from such a service provider changing the ID will probably cause route updates to stop working.

This function was introduced in Qt Mobility 1.1.

See also routeId().

void QGeoRoute::setTravelMode ( QGeoRouteRequest::TravelMode mode )

Sets the travel mode for this route to mode.

This should be one of the travel modes returned by request().travelModes().

This function was introduced in Qt Mobility 1.1.

See also travelMode().

void QGeoRoute::setTravelTime ( int secs )

Sets the estimated amount of time it will take to traverse this route, in seconds, to secs.

This function was introduced in Qt Mobility 1.1.

See also travelTime().

QGeoRouteRequest::TravelMode QGeoRoute::travelMode () const

Returns the travel mode for the this route.

This should be one of the travel modes returned by request().travelModes().

This function was introduced in Qt Mobility 1.1.

See also setTravelMode().

int QGeoRoute::travelTime () const

Returns the estimated amount of time it will take to traverse this route, in seconds.

This function was introduced in Qt Mobility 1.1.

See also setTravelTime().

bool QGeoRoute::operator!= ( const QGeoRoute & other ) const

Returns whether this route and other are not equal.

This function was introduced in Qt Mobility 1.1.

QGeoRoute & QGeoRoute::operator= ( const QGeoRoute & other )

Assigns the contents of other to this route and returns a reference to this route.

This function was introduced in Qt Mobility 1.1.

bool QGeoRoute::operator== ( const QGeoRoute & other ) const

Returns whether this route and other are equal.

This function was introduced in Qt Mobility 1.1.