drifty/comaps
1
0
Fork 0
mirror of https://codeberg.org/comaps/comaps synced 2025-12-21 05:43:37 +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-11-09 23:50:46 +02:00
parent 2b7ee4ba44
commit 90fdf0ed72
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
libs/routing/route.hpp
View File

@@ -210,6 +210,9 @@ public:
* Distance is measured up to the end of the current segment, i.e. including the segment. For the * 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 * 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. * identical to the length of the entire route.
*
* Note that the first and last real (non-fake) segment on the route may not report the actual
* length between their endpoints, but only the part which is also part of the 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; }
@@ -220,6 +223,10 @@ public:
* Travel time is the ETA from the beginning of the route to the end of the current segment, i.e. * 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 * 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. * segment; for the last segment, it is identical to the travel time along the entire route.
*
* Note that the first and last real (non-fake) segment on the route may report time based not
* upon the actual length between their endpoints, but upon the part which is also part of the
* route.
*/ */
double GetTimeFromBeginningSec() const { return m_timeFromBeginningS; } double GetTimeFromBeginningSec() const { return m_timeFromBeginningS; }