Marble::RoutingManager Class Reference

#include <RoutingManager.h>

Inheritance diagram for Marble::RoutingManager:

Public Types
enum	State { Downloading, Retrieved }

Public Slots
void	clearRoute ()
void	retrieveRoute ()
void	reverseRoute ()
void	setGuidanceModeEnabled (bool enabled)

Signals
void	routeRetrieved (GeoDataDocument *route)
void	stateChanged (RoutingManager::State newState)

Public Member Functions
	RoutingManager (MarbleModel *marbleModel, QObject *parent=0)
	~RoutingManager ()
const AutoNavigation *	adjustNavigation () const
AlternativeRoutesModel *	alternativeRoutesModel ()
RoutingProfile	defaultProfile (RoutingProfile::TransportType transportType) const
bool	guidanceModeEnabled () const
QString	lastOpenPath () const
QString	lastSavePath () const
void	loadRoute (const QString &filename)
RoutingProfilesModel *	profilesModel ()
void	readSettings ()
QColor	routeColorAlternative ()
QColor	routeColorHighlighted ()
QColor	routeColorStandard ()
RouteRequest *	routeRequest ()
RoutingModel *	routingModel ()
const RoutingModel *	routingModel () const
void	saveRoute (const QString &filename) const
void	setAutoNavigation (AutoNavigation *adjustNavigation)
void	setLastOpenPath (const QString &path)
void	setLastSavePath (const QString &path)
void	setRouteColorAlternative (QColor color)
void	setRouteColorHighlighted (QColor color)
void	setRouteColorStandard (QColor color)
void	setShowGuidanceModeStartupWarning (bool show)
bool	showGuidanceModeStartupWarning () const
void	writeSettings () const

Detailed Description

Delegates data retrieval and model updates to the appropriate routing provider.

Definition at line 37 of file RoutingManager.h.

Member Enumeration Documentation

enum Marble::RoutingManager::State

Enumerator
Downloading
Retrieved

Definition at line 42 of file RoutingManager.h.

Constructor & Destructor Documentation

Marble::RoutingManager::RoutingManager ( MarbleModel *  marbleModel, QObject *  parent = 0  )

explicit

Constructor.

Definition at line 239 of file RoutingManager.cpp.

Marble::RoutingManager::~RoutingManager

(

)

Destructor.

Definition at line 250 of file RoutingManager.cpp.

Member Function Documentation

const AutoNavigation * Marble::RoutingManager::adjustNavigation

(

)

const

returns the instance of AutoNavigation This is a temporary location for AutoNavigation.

The code would be refactored soon.

Definition at line 321 of file RoutingManager.cpp.

AlternativeRoutesModel * Marble::RoutingManager::alternativeRoutesModel

(

)

Provides access to the model which contains a list of alternative routes.

Definition at line 311 of file RoutingManager.cpp.

void Marble::RoutingManager::clearRoute ( )

slot

Clear all via points.

Definition at line 450 of file RoutingManager.cpp.

RoutingProfile Marble::RoutingManager::defaultProfile

(

RoutingProfile::TransportType

transportType

)

const

Generates a routing profile with default settings for the given transport type.

Definition at line 341 of file RoutingManager.cpp.

bool Marble::RoutingManager::guidanceModeEnabled

(

)

const

Definition at line 516 of file RoutingManager.cpp.

QString Marble::RoutingManager::lastOpenPath

(

)

const

Return last directory the user opened a route from.

Definition at line 471 of file RoutingManager.cpp.

QString Marble::RoutingManager::lastSavePath

(

)

const

Return last directory the user saved a route to.

Definition at line 481 of file RoutingManager.cpp.

void Marble::RoutingManager::loadRoute

(

const QString &

filename

)

Opens the given filename (kml format) and loads the route contained in it.

Definition at line 336 of file RoutingManager.cpp.

RoutingProfilesModel * Marble::RoutingManager::profilesModel

(

)

Provides access to the model which contains all possible routing profiles.

Definition at line 255 of file RoutingManager.cpp.

void Marble::RoutingManager::readSettings

(

)

Restores a previously saved route request and route from disk, if any.

Definition at line 373 of file RoutingManager.cpp.

void Marble::RoutingManager::retrieveRoute ( )

slot

Retrieve a route suiting the routeRequest.

Definition at line 275 of file RoutingManager.cpp.

void Marble::RoutingManager::reverseRoute ( )

slot

Reverse the previously requested route, i.e.

swap start and destination (and via points, if any)

Definition at line 444 of file RoutingManager.cpp.

QColor Marble::RoutingManager::routeColorAlternative

(

)

Get color for alternative route rendering.

Definition at line 511 of file RoutingManager.cpp.

QColor Marble::RoutingManager::routeColorHighlighted

(

)

Get color for highlighted route rendering.

Definition at line 501 of file RoutingManager.cpp.

QColor Marble::RoutingManager::routeColorStandard

(

)

Get color for standard route rendering.

Definition at line 491 of file RoutingManager.cpp.

RouteRequest * Marble::RoutingManager::routeRequest

(

)

Returns the current route request.

Definition at line 270 of file RoutingManager.cpp.

void Marble::RoutingManager::routeRetrieved ( GeoDataDocument *  route )

signal

RoutingModel * Marble::RoutingManager::routingModel

(

)

Provides access to the routing model which contains a list of routing instructions describing steps to get from the source to the destination.

See also

retrieveDirections

Definition at line 260 of file RoutingManager.cpp.

const RoutingModel * Marble::RoutingManager::routingModel

(

)

const

Definition at line 265 of file RoutingManager.cpp.

void Marble::RoutingManager::saveRoute

(

const QString &

filename

)

const

Saves the current route to the file with the given filename.

Existing files will be overwritten. The route is saved in kml format.

Definition at line 331 of file RoutingManager.cpp.

void Marble::RoutingManager::setAutoNavigation

(

AutoNavigation *

adjustNavigation

)

Definition at line 316 of file RoutingManager.cpp.

void Marble::RoutingManager::setGuidanceModeEnabled ( bool  enabled )

slot

Toggle turn by turn navigation mode.

Definition at line 378 of file RoutingManager.cpp.

void Marble::RoutingManager::setLastOpenPath

(

const QString &

path

)

Set last directory the user opened a route from.

Definition at line 466 of file RoutingManager.cpp.

void Marble::RoutingManager::setLastSavePath

(

const QString &

path

)

Set last directory the user saved a route to.

Definition at line 476 of file RoutingManager.cpp.

void Marble::RoutingManager::setRouteColorAlternative

(

QColor

color

)

Set color for alternative route rendering.

Definition at line 506 of file RoutingManager.cpp.

void Marble::RoutingManager::setRouteColorHighlighted

(

QColor

color

)

Set color for highlighted route rendering.

Definition at line 496 of file RoutingManager.cpp.

void Marble::RoutingManager::setRouteColorStandard

(

QColor

color

)

Set color for standard route rendering.

Definition at line 486 of file RoutingManager.cpp.

void Marble::RoutingManager::setShowGuidanceModeStartupWarning

(

bool

show

)

Set whether a warning message should be shown to the user before starting guidance mode.

Definition at line 456 of file RoutingManager.cpp.

bool Marble::RoutingManager::showGuidanceModeStartupWarning

(

)

const

Returns true (default) if a warning is shown to the user when starting guidance mode.

Definition at line 461 of file RoutingManager.cpp.

void Marble::RoutingManager::stateChanged ( RoutingManager::State  newState )

signal

Directions and waypoints for the given route are being downloaded or have been retrieved – newState tells which of both.

void Marble::RoutingManager::writeSettings

(

)

const

Saves the current route request and the current route to disk.

Definition at line 326 of file RoutingManager.cpp.

---

The documentation for this class was generated from the following files:

• RoutingManager.h
• RoutingManager.cpp