libosmscout  0.1
osmscout::NavigationModel Class Reference

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)
 
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
 
QStringList getLaneTurns () const
 
double getMaxAllowedSpeed () const
 
QObject * getNextRoutStep ()
 
bool getPositionEstimateInTunnel () const
 
double getRemainingDinstance () const
 
QObject * getRoute () const
 
OverlayWaygetRouteWay () const
 
OverlayWaygetRouteWayAhead () const
 
OverlayWaygetRouteWayPassed () const
 
int getSuggestedLaneFrom () const
 
int getSuggestedLaneTo () const
 
VehiclePositiongetVehiclePosition () 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
 
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

Constructor & Destructor Documentation

◆ NavigationModel()

◆ ~NavigationModel()

osmscout::NavigationModel::~NavigationModel ( )
override

Member Function Documentation

◆ arrivalUpdate

void osmscout::NavigationModel::arrivalUpdate ( )
signal

◆ currentSpeedUpdate

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

Referenced by onCurrentSpeed(), and setRoute().

◆ data()

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

◆ flags()

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

◆ getArrivalEstimate()

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

◆ getCurrentSpeed()

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

◆ getLaneCount()

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

◆ getLaneTurns()

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

◆ getMaxAllowedSpeed()

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

◆ getNextRoutStep()

QObject * osmscout::NavigationModel::getNextRoutStep ( )

References nextRouteStep.

◆ getPositionEstimateInTunnel()

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

◆ getRemainingDinstance()

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

◆ getRoute()

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

References route.

◆ getRouteWay()

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

◆ 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

◆ isLaneSuggested()

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

◆ isPositionOnRoute()

bool osmscout::NavigationModel::isPositionOnRoute ( )

◆ laneUpdate

void osmscout::NavigationModel::laneUpdate ( )
signal

Referenced by onLaneUpdate().

◆ locationChanged

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

References positionChange().

◆ maxAllowedSpeedUpdate

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

Referenced by onMaxAllowedSpeed(), and setRoute().

◆ onArrivalEstimate

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

◆ onCurrentSpeed

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

References currentSpeed, and currentSpeedUpdate().

Referenced by NavigationModel().

◆ onLaneUpdate

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

References laneUpdate().

Referenced by NavigationModel().

◆ onMaxAllowedSpeed

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

◆ onPositionEstimate

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

◆ onRerouteRequest

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

◆ onTargetReached

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

◆ onUpdate

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

Referenced by NavigationModel().

◆ onUpdateNext

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

◆ positionChange

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

Referenced by locationChanged(), and NavigationModel().

◆ positionEstimate

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

Referenced by onPositionEstimate().

◆ positionEstimateInTunnelChanged

void osmscout::NavigationModel::positionEstimateInTunnelChanged ( )
signal

Referenced by onPositionEstimate(), and setRoute().

◆ rerouteRequest

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

Referenced by onRerouteRequest().

◆ roleNames()

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

◆ routeAheadChanged

void osmscout::NavigationModel::routeAheadChanged ( )
signal

Referenced by NavigationModel().

◆ routeChanged

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

Referenced by NavigationModel(), and setRoute().

◆ rowCount()

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

References route.

◆ setRoute()

◆ targetReached

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

Referenced by onTargetReached().

◆ update

void osmscout::NavigationModel::update ( )
signal

Referenced by onUpdateNext(), and setRoute().

◆ vehiclePositionChanged

void osmscout::NavigationModel::vehiclePositionChanged ( )
signal

Property Documentation

◆ arrivalEstimate

QDateTime osmscout::NavigationModel::arrivalEstimate
read

Referenced by onArrivalEstimate(), and setRoute().

◆ currentSpeed

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

Referenced by onCurrentSpeed().

◆ laneCount

int osmscout::NavigationModel::laneCount
read

◆ laneSuggested

bool osmscout::NavigationModel::laneSuggested
read

◆ laneTurns

QStringList osmscout::NavigationModel::laneTurns
read

◆ maxAllowedSpeed

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

Referenced by onMaxAllowedSpeed().

◆ nextRouteStep

QObject osmscout::NavigationModel::nextRouteStep
read

◆ positionEstimateInTunnel

bool osmscout::NavigationModel::positionEstimateInTunnel
read

◆ remainingDistance

double osmscout::NavigationModel::remainingDistance
read

◆ route

QObject osmscout::NavigationModel::route
readwrite

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