osmscout::RoutingListModel Class Reference

#include <libosmscout-client-qt/include/osmscoutclientqt/RoutingModel.h>

Inheritance diagram for osmscout::RoutingListModel:

Collaboration diagram for osmscout::RoutingListModel:

Public Types
using	Roles = RouteStep::Roles

Public Slots
void	setStartAndTarget (LocationEntry *start, LocationEntry *target, QString vehicleStr="car", double vehicleBearing=-1)
void	setStartAndTarget (LocationEntry *start, LocationEntry *target, QmlRoutingProfile *routingProfile, double vehicleBearing=-1)
void	clear ()
void	cancel ()
void	onRouteComputed (QtRouteData route, int requestId)
void	onRouteFailed (QString reason, int requestId)
void	onRoutingProgress (int percent, int requestId)

Signals
void	routeRequest (LocationEntryRef start, LocationEntryRef target, QmlRoutingProfileRef profile, int requestId, osmscout::BreakerRef breaker, std::optional< osmscout::Bearing > bearing)
void	computingChanged ()
void	routeFailed (QString reason)
void	routingProgress (int percent)

Public Member Functions
	RoutingListModel (QObject *parent=nullptr)
	RoutingListModel (const RoutingListModel &)=delete
	RoutingListModel (RoutingListModel &&)=delete
	~RoutingListModel () override
RoutingListModel &	operator= (const RoutingListModel &)=delete
RoutingListModel &	operator= (RoutingListModel &&)=delete
QVariant	data (const QModelIndex &index, int role) const override
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
double	getRouteLength () const
double	getRouteDuration () const
Qt::ItemFlags	flags (const QModelIndex &index) const override
QHash< int, QByteArray >	roleNames () const override
Q_INVOKABLE QObject *	get (int row) const
bool	isReady ()
Q_INVOKABLE QStringList	availableVehicles ()
Q_INVOKABLE QObject *	locationEntryFromPosition (double lat, double lon, QString label="")
QObject *	getRoute () const
OverlayWay *	getRouteWay ()

Properties
int	count
bool	ready
QObject *	routeWay
QObject *	route
double	length
double	duration

Member Typedef Documentation

Roles

using osmscout::RoutingListModel::Roles = RouteStep::Roles

Constructor & Destructor Documentation

RoutingListModel() [1/3]

osmscout::RoutingListModel::RoutingListModel ( QObject * parent = nullptr )

explicit

RoutingListModel() [2/3]

osmscout::RoutingListModel::RoutingListModel ( const RoutingListModel & )

delete

RoutingListModel() [3/3]

osmscout::RoutingListModel::RoutingListModel ( RoutingListModel && )

delete

~RoutingListModel()

osmscout::RoutingListModel::~RoutingListModel ( )

override

Member Function Documentation

availableVehicles()

Q_INVOKABLE QStringList osmscout::RoutingListModel::availableVehicles ( )

inline

cancel

void osmscout::RoutingListModel::cancel ( )

slot

clear

void osmscout::RoutingListModel::clear ( )

slot

computingChanged

void osmscout::RoutingListModel::computingChanged ( )

signal

data()

QVariant osmscout::RoutingListModel::data ( const QModelIndex & index, int role ) const

override

flags()

Qt::ItemFlags osmscout::RoutingListModel::flags ( const QModelIndex & index ) const

override

get()

Q_INVOKABLE QObject * osmscout::RoutingListModel::get

(

int

row

)

const

getRoute()

QObject * osmscout::RoutingListModel::getRoute ( ) const

inline

getRouteDuration()

double osmscout::RoutingListModel::getRouteDuration

(

)

const

Route duration in seconds

Returns

getRouteLength()

double osmscout::RoutingListModel::getRouteLength

(

)

const

Route length in meters

Returns

getRouteWay()

OverlayWay * osmscout::RoutingListModel::getRouteWay ( )

inline

isReady()

bool osmscout::RoutingListModel::isReady ( )

inline

locationEntryFromPosition()

Q_INVOKABLE QObject * osmscout::RoutingListModel::locationEntryFromPosition ( double lat, double lon, QString label = "" )

inline

Create LocationEntry from geographic coordinate with optional label. It may be used from QML when selecting route start/end via point on map.

onRouteComputed

void osmscout::RoutingListModel::onRouteComputed ( QtRouteData route, int requestId )

slot

onRouteFailed

void osmscout::RoutingListModel::onRouteFailed ( QString reason, int requestId )

slot

onRoutingProgress

void osmscout::RoutingListModel::onRoutingProgress ( int percent, int requestId )

slot

operator=() [1/2]

RoutingListModel & osmscout::RoutingListModel::operator= ( const RoutingListModel & )

delete

operator=() [2/2]

RoutingListModel & osmscout::RoutingListModel::operator= ( RoutingListModel && )

delete

roleNames()

QHash< int, QByteArray > osmscout::RoutingListModel::roleNames ( ) const

override

routeFailed

void osmscout::RoutingListModel::routeFailed ( QString reason )

signal

routeRequest

void osmscout::RoutingListModel::routeRequest ( LocationEntryRef start, LocationEntryRef target, QmlRoutingProfileRef profile, int requestId, osmscout::BreakerRef breaker, std::optional< osmscout::Bearing > bearing )

signal

routingProgress

void osmscout::RoutingListModel::routingProgress ( int percent )

signal

rowCount()

int osmscout::RoutingListModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

override

setStartAndTarget [1/2]

void osmscout::RoutingListModel::setStartAndTarget ( LocationEntry * start, LocationEntry * target, QmlRoutingProfile * routingProfile, double vehicleBearing = -1 )

slot

Compute new route.

Parameters

start
target
routingProfile	profile of the routing
vehicleBearing	in radians, when negative, it is not taken into account

setStartAndTarget [2/2]

void osmscout::RoutingListModel::setStartAndTarget ( LocationEntry * start, LocationEntry * target, QString vehicleStr = "car", double vehicleBearing = -1 )

slot

Compute new route.

Parameters

start
target
vehicleStr	predefined vehicle string. It may be car|bicycle|foot
vehicleBearing	in radians, when negative, it is not taken into account

Property Documentation

count

int osmscout::RoutingListModel::count

read

duration

double osmscout::RoutingListModel::duration

read

length

double osmscout::RoutingListModel::length

read

ready

bool osmscout::RoutingListModel::ready

read

route

QObject * osmscout::RoutingListModel::route

read

routeWay

QObject * osmscout::RoutingListModel::routeWay

read

---

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

• libosmscout-client-qt/include/osmscoutclientqt/RoutingModel.h