NavigationModel.h

Go to the documentation of this file.

#ifndef OSMSCOUT_CLIENT_QT_NAVIGATIONMODEL_H
#define OSMSCOUT_CLIENT_QT_NAVIGATIONMODEL_H

/*
 OSMScout - a Qt backend for libosmscout and libosmscout-map
 Copyright (C) 2018 Lukas Karas

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 */

#include <osmscout/NavigationModule.h>
#include <osmscout/OverlayObject.h>

#include <osmscout/ClientQtImportExport.h>

#include <QObject>

#include <optional>

namespace osmscout {

class OSMSCOUT_CLIENT_QT_API NavigationModel : public QAbstractListModel
{
  Q_OBJECT
  Q_PROPERTY(QObject *route          READ getRoute          WRITE setRoute NOTIFY routeChanged)
  Q_PROPERTY(QObject *routeWay       READ getRouteWay       NOTIFY routeChanged)
  Q_PROPERTY(QObject *routeWayAhead  READ getRouteWayAhead  NOTIFY routeAheadChanged)
  Q_PROPERTY(QObject *routeWayPassed READ getRouteWayPassed NOTIFY routeAheadChanged)
  Q_PROPERTY(QObject *nextRouteStep  READ getNextRoutStep   NOTIFY update)

  Q_PROPERTY(QObject *vehiclePosition  READ getVehiclePosition    NOTIFY vehiclePositionChanged)

  Q_PROPERTY(QDateTime arrivalEstimate READ getArrivalEstimate    NOTIFY arrivalUpdate)
  Q_PROPERTY(double remainingDistance  READ getRemainingDinstance NOTIFY arrivalUpdate)

  // km/h, <0 when unknown
  Q_PROPERTY(double currentSpeed    READ getCurrentSpeed    NOTIFY currentSpeedUpdate)
  // km/h <0 when unknown
  Q_PROPERTY(double maxAllowedSpeed READ getMaxAllowedSpeed NOTIFY maxAllowedSpeedUpdate)

  Q_PROPERTY(int laneCount READ getLaneCount NOTIFY laneUpdate)
  Q_PROPERTY(bool laneSuggested READ isLaneSuggested NOTIFY laneUpdate)
  Q_PROPERTY(int suggestedLaneFrom READ getSuggestedLaneFrom NOTIFY laneUpdate)
  Q_PROPERTY(int suggestedLaneTo READ getSuggestedLaneTo NOTIFY laneUpdate)
  Q_PROPERTY(QStringList laneTurns READ getLaneTurns NOTIFY laneUpdate)

signals:
  void update();

  void arrivalUpdate();
  void routeAheadChanged();

  void vehiclePositionChanged();

  void routeChanged(QtRouteData route,
                    osmscout::Vehicle vehicle);

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

  void rerouteRequest(double fromLat, double fromLon,
                      const QString bearing,
                      double bearingAngle,
                      double toLat, double toLon);

  void targetReached(QString targetBearing, double targetDistance);

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

  void currentSpeedUpdate(double currentSpeed);
  void maxAllowedSpeedUpdate(double maxAllowedSpeed);

  void laneUpdate();

public slots:
  void locationChanged(bool locationValid,
                       double lat, double lon,
                       bool horizontalAccuracyValid, double horizontalAccuracy);

  void onUpdate(std::list<RouteStep> instructions);

  void onUpdateNext(RouteStep nextRouteInstruction);

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

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

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

  void onArrivalEstimate(QDateTime arrivalEstimate, osmscout::Distance remainingDistance);

  void onCurrentSpeed(double currentSpeed);
  void onMaxAllowedSpeed(double maxAllowedSpeed);

  void onLaneUpdate(osmscout::LaneAgent::Lane lane);

public:
  using Roles = RouteStep::Roles;

public:
  NavigationModel();

  virtual ~NavigationModel();

  bool isPositionOnRoute();

  QObject *getRoute() const;
  void setRoute(QObject *route);

  QObject *getNextRoutStep();

  QVariant data(const QModelIndex &index, int role) const;

  int rowCount(const QModelIndex &parent = QModelIndex()) const;

  Qt::ItemFlags flags(const QModelIndex &index) const;

  QHash<int, QByteArray> roleNames() const;

  inline OverlayWay* getRouteWay() const
  {
    if (!route){
      return nullptr;
    }
    return new OverlayWay(route.routeWay().nodes);
  }

  OverlayWay* getRouteWayAhead() const;
  OverlayWay* getRouteWayPassed() const;

  inline VehiclePosition* getVehiclePosition() const
  {
    if (!route || vehicleState==PositionAgent::Uninitialised){
      return nullptr;
    }
    return new VehiclePosition(vehicle, vehicleState, vehicleCoord, vehicleBearing,
        nextRouteStep.getType().isEmpty() ? std::nullopt : std::optional<GeoCoord>(nextRouteStep.GetCoord()));
  }

  inline QDateTime getArrivalEstimate() const
  {
    return arrivalEstimate;
  }

  inline double getRemainingDinstance() const
  {
    if (!remainingDistance.has_value()){
      return 0;
    }
    return remainingDistance->AsMeter();
  }

  inline double getCurrentSpeed() const
  {
    return currentSpeed;
  }

  inline double getMaxAllowedSpeed() const
  {
    return maxAllowedSpeed;
  }

  int getLaneCount() const
  {
    return lane.count;
  }

  bool isLaneSuggested() const
  {
    return lane.suggested;
  }

  int getSuggestedLaneFrom() const
  {
    return lane.suggestedFrom;
  }

  int getSuggestedLaneTo() const
  {
    return lane.suggestedTo;
  }

  QStringList getLaneTurns() const
  {
    QStringList result;
    for (const auto &turn : lane.turns){
      result << QString::fromStdString(turn);
    }
    return result;
  }

private:
  NavigationModule* navigationModule;
  QtRouteData       route;

  Vehicle vehicle;
  PositionAgent::PositionState vehicleState{PositionAgent::Uninitialised};
  GeoCoord vehicleCoord;
  std::optional<osmscout::Bearing> vehicleBearing;

  std::vector<RouteStep> routeSteps;
  RouteStep nextRouteStep;

  QDateTime arrivalEstimate;
  std::optional<osmscout::Distance> remainingDistance;

  double currentSpeed{-1};
  double maxAllowedSpeed{-1};

  LaneAgent::Lane lane;
};

}

#endif //OSMSCOUT_CLIENT_QT_NAVIGATIONMODEL_H