libosmscout  0.1
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
Public Types | Public Slots | Signals | Public Member Functions | Properties | List of all members
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 wehicle leave current route. More...
 
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(), and osmscout::NavigationModule::updateNext().

◆ ~NavigationModel()

osmscout::NavigationModel::~NavigationModel ( )
override

Member Function Documentation

◆ arrivalUpdate

void osmscout::NavigationModel::arrivalUpdate ( )
signal

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

◆ 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

References osmscout::RouteStep::data().

◆ 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

◆ 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

◆ getNextRoutStep()

QObject * osmscout::NavigationModel::getNextRoutStep ( )

References nextRouteStep.

◆ getPositionEstimateInTunnel()

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

References osmscout::PositionAgent::EstimateInTunnel.

◆ getRemainingDistance()

double osmscout::NavigationModel::getRemainingDistance ( ) 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

References osmscout::PositionAgent::Uninitialised.

◆ isLaneSuggested()

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

◆ isPositionOnRoute()

bool osmscout::NavigationModel::isPositionOnRoute ( )

◆ laneUpdate

void osmscout::NavigationModel::laneUpdate ( )
signal

Referenced by onLaneUpdate(), and setRoute().

◆ 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

References arrivalEstimate, arrivalUpdate(), and remainingDistance.

Referenced by NavigationModel().

◆ 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

References maxAllowedSpeed, and maxAllowedSpeedUpdate().

Referenced by 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 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 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 NavigationModel().

◆ onUpdate

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

Referenced by NavigationModel().

◆ onUpdateNext

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

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

Referenced by NavigationModel().

◆ 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

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

bearingAngle is in radians.

Referenced by onRerouteRequest().

◆ roleNames()

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

References osmscout::RouteStep::roleNames().

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

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

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

◆ 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

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

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

◆ laneTurn

QString osmscout::NavigationModel::laneTurn
read

◆ laneTurns

QStringList osmscout::NavigationModel::laneTurns
read

◆ maxAllowedSpeed

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

Referenced by onMaxAllowedSpeed().

◆ nextRouteStep

QObject osmscout::NavigationModel::nextRouteStep
read

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

◆ positionEstimateInTunnel

bool osmscout::NavigationModel::positionEstimateInTunnel
read

◆ remainingDistance

double osmscout::NavigationModel::remainingDistance
read

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

◆ route

QObject osmscout::NavigationModel::route
readwrite

Referenced by getRoute(), getRouteWayAhead(), getRouteWayPassed(), 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: