#pragma once #include "routing/async_router.hpp" #include "routing/route.hpp" #include "routing/router.hpp" #include "routing/routing_callbacks.hpp" #include "routing/routing_exceptions.hpp" #include "routing/speed_camera.hpp" #include "routing/speed_camera_manager.hpp" #include "routing/turns.hpp" #include "routing/turns_notification_manager.hpp" #include "traffic/speed_groups.hpp" #include "traffic/traffic_cache.hpp" #include "traffic/traffic_info.hpp" #include "platform/location.hpp" #include "platform/measurement_utils.hpp" #include "geometry/point2d.hpp" #include "geometry/polyline2d.hpp" #include "base/thread_checker.hpp" #include #include #include #include #include #include #include namespace location { class RouteMatchingInfo; } namespace routing { /// \breaf This class is responsible for the route built in the program. /// \note All method of this class should be called from ui thread if there's no /// a special note near a method. class RoutingSession : public traffic::TrafficObserver, public traffic::TrafficCache { friend struct UnitClass_AsyncGuiThreadTestWithRoutingSession_TestFollowRoutePercentTest; public: enum State { RoutingNotActive, RouteBuilding, // we requested a route and wait when it will be builded RouteNotReady, // routing was not build RouteNotStarted, // route is builded but the user isn't on it OnRoute, // user follows the route RouteNeedRebuild, // user left the route RouteFinished, // destination point is reached but the session isn't closed RouteNoFollowing, // route is built but following mode has been disabled RouteRebuilding, // we requested a route rebuild and wait when it will be rebuilded }; /* * RoutingNotActive -> RouteBuilding // start route building * RouteBuilding -> RouteNotReady // waiting for route in case of building a new route * RouteBuilding -> RouteNotStarted // route is builded in case of building a new route * RouteRebuilding -> RouteNotReady // waiting for route in case of rebuilding * RouteRebuilding -> RouteNotStarted // route is builded in case of rebuilding * RouteNotStarted -> OnRoute // user started following the route * RouteNotStarted -> RouteNeedRebuild // user doesn't like the route. * OnRoute -> RouteNeedRebuild // user moves away from route - need to rebuild * OnRoute -> RouteNoFollowing // following mode was disabled. Router doesn't track position. * OnRoute -> RouteFinished // user reached the end of route * RouteNeedRebuild -> RouteNotReady // start rebuild route * RouteFinished -> RouteNotReady // start new route */ RoutingSession(); void Init(RoutingStatisticsCallback const & routingStatisticsFn, PointCheckCallback const & pointCheckCallback); void SetRouter(std::unique_ptr && router, std::unique_ptr && fetcher); /// @param[in] checkpoints in mercator /// @param[in] timeoutSec timeout in seconds, if zero then there is no timeout void BuildRoute(Checkpoints const & checkpoints, uint32_t timeoutSec); void RebuildRoute(m2::PointD const & startPoint, ReadyCallback const & readyCallback, NeedMoreMapsCallback const & needMoreMapsCallback, RemoveRouteCallback const & removeRouteCallback, uint32_t timeoutSec, State routeRebuildingState, bool adjustToPrevRoute); m2::PointD GetStartPoint() const; m2::PointD GetEndPoint() const; bool IsActive() const; bool IsNavigable() const; bool IsBuilt() const; /// \returns true if a new route is in process of building rebuilding or /// if a route is being rebuilt in case the user left the route, and false otherwise. bool IsBuilding() const; bool IsBuildingOnly() const; bool IsRebuildingOnly() const; bool IsNotReady() const; bool IsFinished() const; bool IsNoFollowing() const; bool IsOnRoute() const; bool IsFollowing() const; void Reset(); inline void SetState(State state) { m_state = state; } /// \returns true if altitude information along |m_route| is available and /// false otherwise. bool HasRouteAltitude() const; bool IsRouteId(uint64_t routeId) const; bool IsRouteValid() const; /// \brief copies distance from route beginning to ends of route segments in meters and /// route altitude information to |routeSegDistanceM| and |routeAltitudes|. /// \returns true if there is valid route information. If the route is not valid returns false. bool GetRouteAltitudesAndDistancesM(std::vector & routeSegDistanceM, feature::TAltitudes & routeAltitudesM) const; State OnLocationPositionChanged(location::GpsInfo const & info); void GetRouteFollowingInfo(location::FollowingInfo & info) const; void MatchLocationToRoute(location::GpsInfo & location, location::RouteMatchingInfo & routeMatchingInfo) const; // Get traffic speed for the current route position. // Returns SpeedGroup::Unknown if any trouble happens: position doesn't match with route or something else. traffic::SpeedGroup MatchTraffic(location::RouteMatchingInfo const & routeMatchingInfo) const; void SetUserCurrentPosition(m2::PointD const & position); void ActivateAdditionalFeatures() {} /// Disable following mode on GPS updates. Following mode is disabled only for the current route. /// If a route is rebuilt you must call DisableFollowMode again. /// Returns true if following was disabled, false if a route is not ready for the following yet. bool DisableFollowMode(); /// Now indicates only that user pushed start button. Route follows by default. /// Returns true if following was enabled, false if a route is not ready for the following yet. bool EnableFollowMode(); void SetRoutingSettings(RoutingSettings const & routingSettings); void SetRoutingCallbacks(ReadyCallback const & buildReadyCallback, ReadyCallback const & rebuildReadyCallback, NeedMoreMapsCallback const & needMoreMapsCallback, RemoveRouteCallback const & removeRouteCallback); void SetProgressCallback(ProgressCallback const & progressCallback); void SetCheckpointCallback(CheckpointCallback const & checkpointCallback); void SetSpeedCamShowCallback(SpeedCameraShowCallback && callback); void SetSpeedCamClearCallback(SpeedCameraClearCallback && callback); // Sound notifications for turn instructions. void GenerateNotifications(std::vector & notifications); void EnableTurnNotifications(bool enable); void SetTurnNotificationsUnits(measurement_utils::Units const units); void SetTurnNotificationsLocale(std::string const & locale); bool AreTurnNotificationsEnabled() const; std::string GetTurnNotificationsLocale() const; void SetLocaleWithJsonForTesting(std::string const & json, std::string const & locale); void EmitCloseRoutingEvent() const; void RouteCall(RouteCallback const & callback) const; // RoutingObserver overrides: void OnTrafficInfoClear() override; /// \note. This method may be called from any thread because it touches class data on gui thread. void OnTrafficInfoAdded(traffic::TrafficInfo && info) override; /// \note. This method may be called from any thread because it touches class data on gui thread. void OnTrafficInfoRemoved(MwmSet::MwmId const & mwmId) override; // TrafficCache overrides: /// \note. This method may be called from any thread because it touches only data /// protected by mutex in TrafficCache class. void CopyTraffic(traffic::AllMwmTrafficInfo & trafficColoring) const override; void AssignRouteForTesting(std::shared_ptr route, RouterResultCode e) { AssignRoute(route, e); } bool IsSpeedLimitExceeded() const { return m_speedCameraManager.IsSpeedLimitExceeded(); } SpeedCameraManager & GetSpeedCamManager() { return m_speedCameraManager; } SpeedCameraManager const & GetSpeedCamManager() const { return m_speedCameraManager; } std::shared_ptr GetRouteForTests() const { return m_route; } private: struct DoReadyCallback { RoutingSession & m_rs; ReadyCallback m_callback; DoReadyCallback(RoutingSession & rs, ReadyCallback const & cb) : m_rs(rs), m_callback(cb) {} void operator()(std::shared_ptr route, RouterResultCode e); }; void AssignRoute(std::shared_ptr route, RouterResultCode e); /// RemoveRoute removes m_route and resets route attributes (m_state, m_lastDistance, m_moveAwayCounter). void RemoveRoute(); void RebuildRouteOnTrafficUpdate(); double GetCompletionPercent() const; void PassCheckpoints(); private: std::unique_ptr m_router; std::shared_ptr m_route; State m_state; bool m_isFollowing; Checkpoints m_checkpoints; /// Current position metrics to check for RouteNeedRebuild state. double m_lastDistance = 0.0; int m_moveAwayCounter = 0; m2::PointD m_lastGoodPosition; // |m_currentDirection| is a vector from the position before last good position to last good position. m2::PointD m_currentDirection; m2::PointD m_userCurrentPosition; m2::PointD m_userFormerPosition; bool m_userCurrentPositionValid = false; bool m_userFormerPositionValid = false; // Sound turn notification parameters. turns::sound::NotificationManager m_turnNotificationsMgr; SpeedCameraManager m_speedCameraManager; RoutingSettings m_routingSettings; ReadyCallback m_buildReadyCallback; ReadyCallback m_rebuildReadyCallback; NeedMoreMapsCallback m_needMoreMapsCallback; RemoveRouteCallback m_removeRouteCallback; ProgressCallback m_progressCallback; CheckpointCallback m_checkpointCallback; // Statistics parameters // Passed distance on route including reroutes double m_passedDistanceOnRouteMeters = 0.0; // Rerouting count int m_routingRebuildCount = -1; // -1 for the first rebuild called in BuildRoute(). mutable double m_lastCompletionPercent = 0.0; DECLARE_THREAD_CHECKER(m_threadChecker); }; void FormatDistance(double dist, std::string & value, std::string & suffix); std::string DebugPrint(RoutingSession::State state); } // namespace routing