osmscout::RouteStep Class Reference

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

Inheritance diagram for osmscout::RouteStep:

Collaboration diagram for osmscout::RouteStep:

Public Types

enum

Roles {   ShortDescriptionRole = Qt::UserRole + 1 , DescriptionRole = Qt::UserRole + 2 , TypeRole = Qt::UserRole + 3 , RoundaboutExitRole = Qt::UserRole + 4 ,   RoundaboutClockwiseRole = Qt::UserRole + 5 , latRole = Qt::UserRole + 6 , lonRole = Qt::UserRole + 7 , distanceRole = Qt::UserRole + 8 ,   distanceDeltaRole = Qt::UserRole + 9 , distanceToRole = Qt::UserRole + 10 , timeRole = Qt::UserRole + 11 , timeDeltaRole = Qt::UserRole + 12 ,   streetNamesRole = Qt::UserRole + 13 , destinationsRole = Qt::UserRole + 14 }

Signals
void	update ()

Public Member Functions
	RouteStep ()
	RouteStep (const QString &type, const GeoCoord &coord, const Distance &distance, const Distance &distanceDelta, const Duration &timestamp, const Duration &timestampDelta, const QStringList &streetNames)
	RouteStep (const RouteStep &other)
RouteStep &	operator= (const RouteStep &other)
QString	getType () const
GeoCoord	GetCoord () const
double	getLat () const
double	getLon () const
Distance	GetDistance () const
double	getDistance () const
double	getDistanceDelta () const
double	getDistanceTo () const
double	getTime () const
double	getTimeDelta () const
QString	getDescription () const
QString	getShortDescription () const
QStringList	getStreetNames () const
QStringList	getDestinations () const
int	getRoundaboutExit () const
bool	getRoundaboutClockwise () const
QVariant	data (int role) const

Static Public Member Functions
static QHash< int, QByteArray >	roleNames (QHash< int, QByteArray > roles)

Public Attributes
GeoCoord	coord
	Position.
Distance	distance
	Estimate distance from route start.
Distance	distanceDelta
	Estimate distance from previous route step.
Distance	distanceTo
	Estimate distance to this step (used with navigation).
Duration	timestamp
	Estimate time from route start.
Duration	timestampDelta
	Estimate time from previous route step.

Properties
QString	type
	Type of route step.
double	lat
updatedouble	lon
updatedouble	distance
double	distanceDelta
double	distanceTo
double	time
double	timeDelta
QString	description
	Formatted (html) verbose description (translated already).
QString	shortDescription
	Plain short description (translated already).
QStringList	streetNames
	Street names leading to this step.
QStringList	destinations
	Destinations, visible on road sign usually.
int	roundaboutExit {-1}
	when type is "leave-roundabout" this property indicate number of exit
bool	roundaboutClockwise {false}

Detailed Description

Human representation of route step commands. It contains time, distance and two variants of translated description:

• simple shortTranslation
• formatted description with simple html formatting (just subset supported by Qt components)

Member Enumeration Documentation

Roles

enum osmscout::RouteStep::Roles

Enumerator
ShortDescriptionRole
DescriptionRole
TypeRole
RoundaboutExitRole
RoundaboutClockwiseRole
latRole
lonRole
distanceRole
distanceDeltaRole
distanceToRole
timeRole
timeDeltaRole
streetNamesRole
destinationsRole

Constructor & Destructor Documentation

RouteStep() [1/3]

osmscout::RouteStep::RouteStep ( )

inline

RouteStep() [2/3]

osmscout::RouteStep::RouteStep	(	const QString &	type,
		const GeoCoord &	coord,
		const Distance &	distance,
		const Distance &	distanceDelta,
		const Duration &	timestamp,
		const Duration &	timestampDelta,
		const QStringList &	streetNames )

RouteStep() [3/3]

osmscout::RouteStep::RouteStep

(

const RouteStep &

other

)

Member Function Documentation

data()

QVariant osmscout::RouteStep::data

(

int

role

)

const

GetCoord()

GeoCoord osmscout::RouteStep::GetCoord ( ) const

inline

getDescription()

QString osmscout::RouteStep::getDescription ( ) const

inline

getDestinations()

QStringList osmscout::RouteStep::getDestinations ( ) const

inline

GetDistance()

Distance osmscout::RouteStep::GetDistance ( ) const

inline

getDistance()

double osmscout::RouteStep::getDistance ( ) const

inline

getDistanceDelta()

double osmscout::RouteStep::getDistanceDelta ( ) const

inline

getDistanceTo()

double osmscout::RouteStep::getDistanceTo ( ) const

inline

getLat()

double osmscout::RouteStep::getLat ( ) const

inline

getLon()

double osmscout::RouteStep::getLon ( ) const

inline

getRoundaboutClockwise()

bool osmscout::RouteStep::getRoundaboutClockwise ( ) const

inline

getRoundaboutExit()

int osmscout::RouteStep::getRoundaboutExit ( ) const

inline

getShortDescription()

QString osmscout::RouteStep::getShortDescription ( ) const

inline

getStreetNames()

QStringList osmscout::RouteStep::getStreetNames ( ) const

inline

getTime()

double osmscout::RouteStep::getTime ( ) const

inline

getTimeDelta()

double osmscout::RouteStep::getTimeDelta ( ) const

inline

getType()

QString osmscout::RouteStep::getType ( ) const

inline

operator=()

RouteStep & osmscout::RouteStep::operator=

(

const RouteStep &

other

)

roleNames()

QHash< int, QByteArray > osmscout::RouteStep::roleNames ( QHash< int, QByteArray > roles )

static

update

void osmscout::RouteStep::update ( )

signal

Member Data Documentation

coord

GeoCoord osmscout::RouteStep::coord

Position.

distance

Distance osmscout::RouteStep::distance

Estimate distance from route start.

distanceDelta

Distance osmscout::RouteStep::distanceDelta

Estimate distance from previous route step.

distanceTo

Distance osmscout::RouteStep::distanceTo

Estimate distance to this step (used with navigation).

timestamp

Duration osmscout::RouteStep::timestamp

Estimate time from route start.

timestampDelta

Duration osmscout::RouteStep::timestampDelta

Estimate time from previous route step.

Property Documentation

description

QString osmscout::RouteStep::description

read

Formatted (html) verbose description (translated already).

destinations

QStringList osmscout::RouteStep::destinations

read

Destinations, visible on road sign usually.

distance

updatedouble osmscout::RouteStep::distance

read

distanceDelta

double osmscout::RouteStep::distanceDelta

read

distanceTo

double osmscout::RouteStep::distanceTo

read

lat

double osmscout::RouteStep::lat

read

lon

updatedouble osmscout::RouteStep::lon

read

roundaboutClockwise

bool osmscout::RouteStep::roundaboutClockwise {false}

read

when type is "leave-roundabout" or "enter-roundabout", this property indicate direction of roundabout

• false for counter clockwise, used in continental Europe
• true for clockwise, used in England and Irish

roundaboutExit

int osmscout::RouteStep::roundaboutExit {-1}

read

when type is "leave-roundabout" this property indicate number of exit

shortDescription

QString osmscout::RouteStep::shortDescription

read

Plain short description (translated already).

streetNames

QStringList osmscout::RouteStep::streetNames

read

Street names leading to this step.

time

double osmscout::RouteStep::time

read

timeDelta

double osmscout::RouteStep::timeDelta

read

type

QString osmscout::RouteStep::type

read

Type of route step.

---

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

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