drifty/comaps
1
0
Fork 0
mirror of https://codeberg.org/comaps/comaps synced 2025-12-20 13:23:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

[routing] Documentation

Browse Source 
Signed-off-by: mvglasow <michael -at- vonglasow.com>
This commit is contained in:
mvglasow
2025-10-19 18:02:04 +03:00
parent 32d1a3a36e
commit a313526aed
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
libs/routing/route.hpp
View File

@@ -171,8 +171,23 @@ public:
turns::TurnItem const & GetTurn() const { return m_turn; } turns::TurnItem const & GetTurn() const { return m_turn; }
void ClearTurnLanes() { m_turn.m_lanes.clear(); } void ClearTurnLanes() { m_turn.m_lanes.clear(); }
/**
* @brief Returns distance from the beginning of the route in meters.
*
* Distance is measured up to the end of the current segment, i.e. including the segment. For the
* first segment, this is identical to the length of the segment; for the last segment, it is
* identical to the length of the entire route.
*/
double GetDistFromBeginningMeters() const { return m_distFromBeginningMeters; } double GetDistFromBeginningMeters() const { return m_distFromBeginningMeters; }
double GetDistFromBeginningMerc() const { return m_distFromBeginningMerc; } double GetDistFromBeginningMerc() const { return m_distFromBeginningMerc; }
/**
* @brief Returns travel time from the beginning of the route.
*
* Travel time is the ETA from the beginning of the route to the end of the current segment, i.e.
* including the segment. For the first segment, this is identical to the travel time along the
* segment; for the last segment, it is identical to the travel time along the entire route.
*/
double GetTimeFromBeginningSec() const { return m_timeFromBeginningS; } double GetTimeFromBeginningSec() const { return m_timeFromBeginningS; }
bool HasTransitInfo() const { return m_transitInfo.HasTransitInfo(); } bool HasTransitInfo() const { return m_transitInfo.HasTransitInfo(); }