libosmscout 0.1
Loading...
Searching...
No Matches
osmscout::RouteStep Class Reference
Qt API

Human representation of route step commands. More...

#include <RouteStep.h>

Inheritance 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

QVariant data (int role) const
GeoCoord GetCoord () const
QString getDescription () const
QStringList getDestinations () const
Distance GetDistance () const
double getDistance () const
double getDistanceDelta () const
double getDistanceTo () const
double getLat () const
double getLon () const
bool getRoundaboutClockwise () const
int getRoundaboutExit () const
QString getShortDescription () const
QStringList getStreetNames () const
double getTime () const
double getTimeDelta () const
QString getType () const
RouteStep & operator= (const RouteStep &other)
 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)

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

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

References RouteStep().

Referenced by operator=(), RouteStep(), and RouteStep().

◆ 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 )

References coord, distance, distanceDelta, distanceTo, streetNames, timestamp, timestampDelta, and type.

◆ RouteStep() [3/3]

osmscout::RouteStep::RouteStep ( const RouteStep & other)

References coord, description, destinations, distance, distanceDelta, distanceTo, roundaboutClockwise, roundaboutExit, RouteStep(), shortDescription, streetNames, timestamp, timestampDelta, and type.

Member Function Documentation

◆ data()

QVariant osmscout::RouteStep::data ( int role) const

References DescriptionRole, destinations, destinationsRole, distanceDeltaRole, distanceRole, distanceToRole, getDescription(), getDistance(), getDistanceDelta(), getDistanceTo(), getLat(), getLon(), getRoundaboutClockwise(), getRoundaboutExit(), getShortDescription(), getTime(), getTimeDelta(), getType(), latRole, lonRole, RoundaboutClockwiseRole, RoundaboutExitRole, ShortDescriptionRole, streetNames, streetNamesRole, timeDeltaRole, timeRole, and TypeRole.

Referenced by osmscout::NavigationModel::data(), and osmscout::RoutingListModel::data().

◆ GetCoord()

GeoCoord osmscout::RouteStep::GetCoord ( ) const
inline

References coord.

◆ getDescription()

QString osmscout::RouteStep::getDescription ( ) const
inline

References description.

Referenced by data().

◆ getDestinations()

QStringList osmscout::RouteStep::getDestinations ( ) const
inline

References destinations.

◆ GetDistance()

Distance osmscout::RouteStep::GetDistance ( ) const
inline

References distance.

◆ getDistance()

double osmscout::RouteStep::getDistance ( ) const
inline

References distance.

Referenced by data().

◆ getDistanceDelta()

double osmscout::RouteStep::getDistanceDelta ( ) const
inline

References distanceDelta.

Referenced by data().

◆ getDistanceTo()

double osmscout::RouteStep::getDistanceTo ( ) const
inline

References distanceTo.

Referenced by data().

◆ getLat()

double osmscout::RouteStep::getLat ( ) const
inline

References coord.

Referenced by data().

◆ getLon()

double osmscout::RouteStep::getLon ( ) const
inline

References coord.

Referenced by data().

◆ getRoundaboutClockwise()

bool osmscout::RouteStep::getRoundaboutClockwise ( ) const
inline

References roundaboutClockwise.

Referenced by data().

◆ getRoundaboutExit()

int osmscout::RouteStep::getRoundaboutExit ( ) const
inline

References roundaboutExit.

Referenced by data().

◆ getShortDescription()

QString osmscout::RouteStep::getShortDescription ( ) const
inline

References shortDescription.

Referenced by data().

◆ getStreetNames()

QStringList osmscout::RouteStep::getStreetNames ( ) const
inline

References streetNames.

◆ getTime()

double osmscout::RouteStep::getTime ( ) const
inline

References osmscout::DurationAsSeconds(), and timestamp.

Referenced by data().

◆ getTimeDelta()

double osmscout::RouteStep::getTimeDelta ( ) const
inline

References osmscout::DurationAsSeconds(), and timestampDelta.

Referenced by data().

◆ getType()

QString osmscout::RouteStep::getType ( ) const
inline

References type.

Referenced by data().

◆ operator=()

RouteStep & osmscout::RouteStep::operator= ( const RouteStep & other)

References coord, description, destinations, distance, distanceDelta, distanceTo, roundaboutClockwise, roundaboutExit, RouteStep(), shortDescription, streetNames, timestamp, timestampDelta, and type.

◆ roleNames()

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

References DescriptionRole, destinationsRole, distanceDeltaRole, distanceRole, distanceToRole, latRole, lonRole, RoundaboutClockwiseRole, RoundaboutExitRole, ShortDescriptionRole, streetNamesRole, timeDeltaRole, timeRole, and TypeRole.

Referenced by osmscout::NavigationModel::roleNames(), and osmscout::RoutingListModel::roleNames().

◆ update

void osmscout::RouteStep::update ( )
signal

References update().

Referenced by update().

Member Data Documentation

◆ coord

GeoCoord osmscout::RouteStep::coord

Position.

Referenced by GetCoord(), getLat(), getLon(), operator=(), RouteStep(), and RouteStep().

◆ 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.

Referenced by getTime(), operator=(), RouteStep(), and RouteStep().

◆ timestampDelta

Duration osmscout::RouteStep::timestampDelta

Estimate time from previous route step.

Referenced by getTimeDelta(), operator=(), RouteStep(), and RouteStep().

Property Documentation

◆ description

QString osmscout::RouteStep::description
read

Formatted (html) verbose description (translated already).

Referenced by getDescription(), osmscout::RouteDescriptionBuilder::Callback::OnMotorwayChange(), osmscout::RouteDescriptionBuilder::Callback::OnMotorwayEnter(), osmscout::RouteDescriptionBuilder::Callback::OnMotorwayLeave(), osmscout::RouteDescriptionBuilder::Callback::OnPathNameChange(), osmscout::RouteDescriptionBuilder::Callback::OnRoundaboutEnter(), osmscout::RouteDescriptionBuilder::Callback::OnRoundaboutLeave(), osmscout::RouteDescriptionBuilder::Callback::OnStart(), osmscout::RouteDescriptionBuilder::Callback::OnTargetReached(), osmscout::RouteDescriptionBuilder::Callback::OnTurn(), operator=(), and RouteStep().

◆ destinations

QStringList osmscout::RouteStep::destinations
read

Destinations, visible on road sign usually.

Referenced by data(), getDestinations(), osmscout::RouteDescriptionBuilder::Callback::OnMotorwayChange(), osmscout::RouteDescriptionBuilder::Callback::OnMotorwayLeave(), operator=(), and RouteStep().

◆ distance

updatedouble osmscout::RouteStep::distance
read

Referenced by osmscout::RouteDescriptionBuilder::GenerateNextRouteInstruction(), GetDistance(), getDistance(), operator=(), RouteStep(), and RouteStep().

◆ distanceDelta

double osmscout::RouteStep::distanceDelta
read

Referenced by getDistanceDelta(), operator=(), RouteStep(), and RouteStep().

◆ distanceTo

double osmscout::RouteStep::distanceTo
read

Referenced by osmscout::RouteDescriptionBuilder::GenerateNextRouteInstruction(), getDistanceTo(), operator=(), RouteStep(), and RouteStep().

◆ 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

Referenced by getRoundaboutClockwise(), osmscout::RouteDescriptionBuilder::Callback::OnRoundaboutEnter(), osmscout::RouteDescriptionBuilder::Callback::OnRoundaboutLeave(), operator=(), and RouteStep().

◆ roundaboutExit

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

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

Referenced by getRoundaboutExit(), osmscout::RouteDescriptionBuilder::Callback::OnRoundaboutLeave(), operator=(), and RouteStep().

◆ shortDescription

QString osmscout::RouteStep::shortDescription
read

Plain short description (translated already).

Referenced by getShortDescription(), osmscout::RouteDescriptionBuilder::Callback::OnMotorwayChange(), osmscout::RouteDescriptionBuilder::Callback::OnMotorwayEnter(), osmscout::RouteDescriptionBuilder::Callback::OnMotorwayLeave(), osmscout::RouteDescriptionBuilder::Callback::OnPathNameChange(), osmscout::RouteDescriptionBuilder::Callback::OnRoundaboutEnter(), osmscout::RouteDescriptionBuilder::Callback::OnRoundaboutLeave(), osmscout::RouteDescriptionBuilder::Callback::OnStart(), osmscout::RouteDescriptionBuilder::Callback::OnTargetReached(), osmscout::RouteDescriptionBuilder::Callback::OnTurn(), operator=(), and RouteStep().

◆ streetNames

QStringList osmscout::RouteStep::streetNames
read

Street names leading to this step.

Referenced by data(), getStreetNames(), operator=(), RouteStep(), and RouteStep().

◆ time

double osmscout::RouteStep::time
read

◆ timeDelta

double osmscout::RouteStep::timeDelta
read

◆ type

QString osmscout::RouteStep::type
read

Type of route step.

Referenced by getType(), operator=(), RouteStep(), and RouteStep().

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