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

Model providing navigation functionality to QML. More...

#include <NavigationModel.h>

Inheritance diagram for osmscout::NavigationModel:

Public Types

using Roles = RouteStep::Roles

Public Slots

void locationChanged (bool locationValid, double lat, double lon, bool horizontalAccuracyValid, double horizontalAccuracy)
void onArrivalEstimate (QDateTime arrivalEstimate, osmscout::Distance remainingDistance)
void onCurrentSpeed (double currentSpeed)
void onLaneUpdate (osmscout::LaneAgent::Lane lane)
void onMaxAllowedSpeed (double maxAllowedSpeed)
void onPositionEstimate (const PositionAgent::PositionState state, const GeoCoord coord, const std::optional< osmscout::Bearing > bearing)
void onRerouteRequest (const GeoCoord from, const std::optional< osmscout::Bearing > initialBearing, const GeoCoord to)
void onTargetReached (const osmscout::Bearing targetBearing, const osmscout::Distance targetDistance)
void onUpdate (std::list< RouteStep > instructions)
void onUpdateNext (RouteStep nextRouteInstruction)

Signals

void arrivalUpdate ()
void currentSpeedUpdate (double currentSpeed)
void laneUpdate ()
void maxAllowedSpeedUpdate (double maxAllowedSpeed)
void positionChange (osmscout::GeoCoord coord, bool horizontalAccuracyValid, double horizontalAccuracy)
void positionEstimate (osmscout::PositionAgent::PositionState state, double lat, double lon, QString bearing)
void positionEstimateInTunnelChanged ()
void rerouteRequest (double fromLat, double fromLon, const QString bearing, double bearingAngle, double toLat, double toLon)
 Requesting computation of the new route when vehicle leave current route.
void routeAheadChanged ()
void routeChanged (QtRouteData route, osmscout::Vehicle vehicle)
void targetReached (QString targetBearing, double targetDistance)
void update ()
void vehiclePositionChanged ()

Public Member Functions

QVariant data (const QModelIndex &index, int role) const override
Qt::ItemFlags flags (const QModelIndex &index) const override
QDateTime getArrivalEstimate () const
double getCurrentSpeed () const
int getLaneCount () const
QString getLaneTurn () const
QStringList getLaneTurns () const
double getMaxAllowedSpeed () const
QObject * getNextRoutStep ()
bool getPositionEstimateInTunnel () const
double getRemainingDistance () const
QObject * getRoute () const
OverlayWay * getRouteWay () const
OverlayWay * getRouteWayAhead () const
OverlayWay * getRouteWayPassed () const
int getSuggestedLaneFrom () const
int getSuggestedLaneTo () const
VehiclePosition * getVehiclePosition () const
bool isLaneSuggested () const
bool isPositionOnRoute ()
 NavigationModel ()
QHash< int, QByteArray > roleNames () const override
int rowCount (const QModelIndex &parent=QModelIndex()) const override
void setRoute (QObject *route)
 ~NavigationModel () override

Properties

QDateTime arrivalEstimate
double currentSpeed {-1}
int laneCount
bool laneSuggested
QString laneTurn
QStringList laneTurns
double maxAllowedSpeed {-1}
QObject * nextRouteStep
bool positionEstimateInTunnel
double remainingDistance
QObject * route
QObject * routeWay
QObject * routeWayAhead
QObject * routeWayPassed
int suggestedLaneFrom
int suggestedLaneTo
QObject * vehiclePosition

Detailed Description

Model providing navigation functionality to QML.

Main logic sits in osmscout::Navigation class and its Qt wrapper NavigationModule.

Member Typedef Documentation

◆ Roles

using osmscout::NavigationModel::Roles = RouteStep::Roles

Constructor & Destructor Documentation

◆ NavigationModel()

osmscout::NavigationModel::NavigationModel ( )

References osmscout::NavigationModule::arrivalEstimate(), arrivalUpdate(), osmscout::NavigationModule::currentSpeed(), osmscout::OSMScoutQt::GetInstance(), osmscout::NavigationModule::laneUpdate(), osmscout::NavigationModule::locationChanged(), osmscout::OSMScoutQt::MakeNavigation(), osmscout::NavigationModule::maxAllowedSpeed(), onArrivalEstimate(), onCurrentSpeed(), onLaneUpdate(), onMaxAllowedSpeed(), onPositionEstimate(), onRerouteRequest(), onTargetReached(), onUpdate(), onUpdateNext(), positionChange(), osmscout::NavigationModule::positionEstimate(), osmscout::NavigationModule::rerouteRequest(), routeAheadChanged(), routeChanged(), osmscout::NavigationModule::setupRoute(), osmscout::NavigationModule::targetReached(), osmscout::NavigationModule::update(), osmscout::NavigationModule::updateNext(), and osmscout::vehicleCar.

◆ ~NavigationModel()

osmscout::NavigationModel::~NavigationModel ( )
override

Member Function Documentation

◆ arrivalUpdate

void osmscout::NavigationModel::arrivalUpdate ( )
signal

References arrivalUpdate().

Referenced by arrivalUpdate(), NavigationModel(), onArrivalEstimate(), and setRoute().

◆ currentSpeedUpdate

void osmscout::NavigationModel::currentSpeedUpdate ( double currentSpeed)
signal

References currentSpeed, and currentSpeedUpdate().

Referenced by currentSpeedUpdate(), onCurrentSpeed(), and setRoute().

◆ data()

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

References osmscout::RouteStep::data().

Referenced by isPositionOnRoute().

◆ flags()

Qt::ItemFlags osmscout::NavigationModel::flags ( const QModelIndex & index) const
override

Referenced by isPositionOnRoute().

◆ getArrivalEstimate()

QDateTime osmscout::NavigationModel::getArrivalEstimate ( ) const
inline

References arrivalEstimate.

◆ getCurrentSpeed()

double osmscout::NavigationModel::getCurrentSpeed ( ) const
inline

References currentSpeed.

◆ getLaneCount()

int osmscout::NavigationModel::getLaneCount ( ) const
inline

◆ getLaneTurn()

QString osmscout::NavigationModel::getLaneTurn ( ) const
inline

References osmscout::LaneTurnString().

◆ getLaneTurns()

QStringList osmscout::NavigationModel::getLaneTurns ( ) const
inline

References osmscout::LaneTurnString().

◆ getMaxAllowedSpeed()

double osmscout::NavigationModel::getMaxAllowedSpeed ( ) const
inline

References maxAllowedSpeed.

◆ getNextRoutStep()

QObject * osmscout::NavigationModel::getNextRoutStep ( )

References nextRouteStep.

Referenced by isPositionOnRoute().

◆ getPositionEstimateInTunnel()

bool osmscout::NavigationModel::getPositionEstimateInTunnel ( ) const
inline

References osmscout::PositionAgent::EstimateInTunnel.

◆ getRemainingDistance()

double osmscout::NavigationModel::getRemainingDistance ( ) const
inline

References remainingDistance.

◆ getRoute()

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

References route.

Referenced by isPositionOnRoute().

◆ getRouteWay()

OverlayWay * osmscout::NavigationModel::getRouteWay ( ) const
inline

References getRouteWay(), and route.

Referenced by getRouteWay().

◆ getRouteWayAhead()

OverlayWay * osmscout::NavigationModel::getRouteWayAhead ( ) const

References remainingDistance, and route.

◆ getRouteWayPassed()

OverlayWay * osmscout::NavigationModel::getRouteWayPassed ( ) const

References remainingDistance, and route.

◆ getSuggestedLaneFrom()

int osmscout::NavigationModel::getSuggestedLaneFrom ( ) const
inline

◆ getSuggestedLaneTo()

int osmscout::NavigationModel::getSuggestedLaneTo ( ) const
inline

◆ getVehiclePosition()

VehiclePosition * osmscout::NavigationModel::getVehiclePosition ( ) const
inline

References nextRouteStep, route, and osmscout::PositionAgent::Uninitialised.

◆ isLaneSuggested()

bool osmscout::NavigationModel::isLaneSuggested ( ) const
inline

◆ isPositionOnRoute()

bool osmscout::NavigationModel::isPositionOnRoute ( )

References data(), flags(), getNextRoutStep(), getRoute(), isPositionOnRoute(), roleNames(), route, rowCount(), and setRoute().

Referenced by isPositionOnRoute().

◆ laneUpdate

void osmscout::NavigationModel::laneUpdate ( )
signal

References arrivalEstimate, currentSpeed, laneUpdate(), locationChanged(), maxAllowedSpeed, onArrivalEstimate(), onCurrentSpeed(), onLaneUpdate(), onMaxAllowedSpeed(), onPositionEstimate(), onRerouteRequest(), onTargetReached(), onUpdate(), onUpdateNext(), and remainingDistance.

Referenced by laneUpdate(), onLaneUpdate(), and setRoute().

◆ locationChanged

void osmscout::NavigationModel::locationChanged ( bool locationValid,
double lat,
double lon,
bool horizontalAccuracyValid,
double horizontalAccuracy )
slot

References positionChange().

Referenced by laneUpdate().

◆ maxAllowedSpeedUpdate

void osmscout::NavigationModel::maxAllowedSpeedUpdate ( double maxAllowedSpeed)
signal

References maxAllowedSpeed, and maxAllowedSpeedUpdate().

Referenced by maxAllowedSpeedUpdate(), onMaxAllowedSpeed(), and setRoute().

◆ onArrivalEstimate

void osmscout::NavigationModel::onArrivalEstimate ( QDateTime arrivalEstimate,
osmscout::Distance remainingDistance )
slot

References arrivalEstimate, arrivalUpdate(), and remainingDistance.

Referenced by laneUpdate(), and NavigationModel().

◆ onCurrentSpeed

void osmscout::NavigationModel::onCurrentSpeed ( double currentSpeed)
slot

References currentSpeed, and currentSpeedUpdate().

Referenced by laneUpdate(), and NavigationModel().

◆ onLaneUpdate

void osmscout::NavigationModel::onLaneUpdate ( osmscout::LaneAgent::Lane lane)
slot

References laneUpdate().

Referenced by laneUpdate(), and NavigationModel().

◆ onMaxAllowedSpeed

void osmscout::NavigationModel::onMaxAllowedSpeed ( double maxAllowedSpeed)
slot

References maxAllowedSpeed, and maxAllowedSpeedUpdate().

Referenced by laneUpdate(), and NavigationModel().

◆ onPositionEstimate

void osmscout::NavigationModel::onPositionEstimate ( const PositionAgent::PositionState state,
const GeoCoord coord,
const std::optional< osmscout::Bearing > bearing )
slot

References osmscout::PositionAgent::EstimateInTunnel, osmscout::GeoCoord::GetLat(), osmscout::GeoCoord::GetLon(), positionEstimate(), positionEstimateInTunnelChanged(), and vehiclePositionChanged().

Referenced by laneUpdate(), and NavigationModel().

◆ onRerouteRequest

void osmscout::NavigationModel::onRerouteRequest ( const GeoCoord from,
const std::optional< osmscout::Bearing > initialBearing,
const GeoCoord to )
slot

References osmscout::GeoCoord::GetLat(), osmscout::GeoCoord::GetLon(), and rerouteRequest().

Referenced by laneUpdate(), and NavigationModel().

◆ onTargetReached

void osmscout::NavigationModel::onTargetReached ( const osmscout::Bearing targetBearing,
const osmscout::Distance targetDistance )
slot

References osmscout::Distance::AsMeter(), osmscout::Bearing::LongDisplayString(), and targetReached().

Referenced by laneUpdate(), and NavigationModel().

◆ onUpdate

void osmscout::NavigationModel::onUpdate ( std::list< RouteStep > instructions)
slot

Referenced by laneUpdate(), and NavigationModel().

◆ onUpdateNext

void osmscout::NavigationModel::onUpdateNext ( RouteStep nextRouteInstruction)
slot

References nextRouteStep, update(), and vehiclePositionChanged().

Referenced by laneUpdate(), and NavigationModel().

◆ positionChange

void osmscout::NavigationModel::positionChange ( osmscout::GeoCoord coord,
bool horizontalAccuracyValid,
double horizontalAccuracy )
signal

References positionChange().

Referenced by locationChanged(), NavigationModel(), and positionChange().

◆ positionEstimate

void osmscout::NavigationModel::positionEstimate ( osmscout::PositionAgent::PositionState state,
double lat,
double lon,
QString bearing )
signal

References positionEstimate().

Referenced by onPositionEstimate(), and positionEstimate().

◆ positionEstimateInTunnelChanged

void osmscout::NavigationModel::positionEstimateInTunnelChanged ( )
signal

References positionEstimateInTunnelChanged().

Referenced by onPositionEstimate(), positionEstimateInTunnelChanged(), and setRoute().

◆ rerouteRequest

void osmscout::NavigationModel::rerouteRequest ( double fromLat,
double fromLon,
const QString bearing,
double bearingAngle,
double toLat,
double toLon )
signal

Requesting computation of the new route when vehicle leave current route.

bearingAngle is in radians.

References rerouteRequest().

Referenced by onRerouteRequest(), and rerouteRequest().

◆ roleNames()

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

References osmscout::RouteStep::roleNames().

Referenced by isPositionOnRoute().

◆ routeAheadChanged

void osmscout::NavigationModel::routeAheadChanged ( )
signal

References routeAheadChanged().

Referenced by NavigationModel(), and routeAheadChanged().

◆ routeChanged

void osmscout::NavigationModel::routeChanged ( QtRouteData route,
osmscout::Vehicle vehicle )
signal

References route, and routeChanged().

Referenced by NavigationModel(), routeChanged(), and setRoute().

◆ rowCount()

int osmscout::NavigationModel::rowCount ( const QModelIndex & parent = QModelIndex()) const
override

References route.

Referenced by isPositionOnRoute().

◆ setRoute()

void osmscout::NavigationModel::setRoute ( QObject * route)

References arrivalEstimate, arrivalUpdate(), currentSpeedUpdate(), laneUpdate(), maxAllowedSpeedUpdate(), nextRouteStep, positionEstimateInTunnelChanged(), remainingDistance, route, routeChanged(), osmscout::PositionAgent::Uninitialised, update(), and vehiclePositionChanged().

Referenced by isPositionOnRoute().

◆ targetReached

void osmscout::NavigationModel::targetReached ( QString targetBearing,
double targetDistance )
signal

References targetReached().

Referenced by onTargetReached(), and targetReached().

◆ update

void osmscout::NavigationModel::update ( )
signal

References update().

Referenced by onUpdateNext(), setRoute(), and update().

◆ vehiclePositionChanged

void osmscout::NavigationModel::vehiclePositionChanged ( )
signal

References vehiclePositionChanged().

Referenced by onPositionEstimate(), onUpdateNext(), setRoute(), and vehiclePositionChanged().

Property Documentation

◆ arrivalEstimate

QDateTime osmscout::NavigationModel::arrivalEstimate
read

Referenced by getArrivalEstimate(), laneUpdate(), onArrivalEstimate(), and setRoute().

◆ currentSpeed

double osmscout::NavigationModel::currentSpeed {-1}
read

Referenced by currentSpeedUpdate(), getCurrentSpeed(), laneUpdate(), and onCurrentSpeed().

◆ laneCount

int osmscout::NavigationModel::laneCount
read

◆ laneSuggested

bool osmscout::NavigationModel::laneSuggested
read

◆ laneTurn

QString osmscout::NavigationModel::laneTurn
read

◆ laneTurns

QStringList osmscout::NavigationModel::laneTurns
read

◆ maxAllowedSpeed

double osmscout::NavigationModel::maxAllowedSpeed {-1}
read

Referenced by getMaxAllowedSpeed(), laneUpdate(), maxAllowedSpeedUpdate(), and onMaxAllowedSpeed().

◆ nextRouteStep

QObject * osmscout::NavigationModel::nextRouteStep
read

Referenced by getNextRoutStep(), getVehiclePosition(), onUpdateNext(), and setRoute().

◆ positionEstimateInTunnel

bool osmscout::NavigationModel::positionEstimateInTunnel
read

◆ remainingDistance

double osmscout::NavigationModel::remainingDistance
read

Referenced by getRemainingDistance(), getRouteWayAhead(), getRouteWayPassed(), laneUpdate(), onArrivalEstimate(), and setRoute().

◆ route

QObject * osmscout::NavigationModel::route
readwrite

Referenced by getRoute(), getRouteWay(), getRouteWayAhead(), getRouteWayPassed(), getVehiclePosition(), isPositionOnRoute(), routeChanged(), rowCount(), and setRoute().

◆ routeWay

QObject * osmscout::NavigationModel::routeWay
read

◆ routeWayAhead

QObject * osmscout::NavigationModel::routeWayAhead
read

◆ routeWayPassed

QObject * osmscout::NavigationModel::routeWayPassed
read

◆ suggestedLaneFrom

int osmscout::NavigationModel::suggestedLaneFrom
read

◆ suggestedLaneTo

int osmscout::NavigationModel::suggestedLaneTo
read

◆ vehiclePosition

QObject * osmscout::NavigationModel::vehiclePosition
read
The documentation for this class was generated from the following files: