drifty/comaps
1
0
Fork 0
mirror of https://codeberg.org/comaps/comaps synced 2025-12-19 13:03:36 +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 17:45:35 +03:00
parent 4e624bd04b
commit 3a45740884
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
libs/routing/route.hpp
View File

@@ -39,8 +39,21 @@ namespace routing
using SubrouteUid = uint64_t;
SubrouteUid constexpr kInvalidSubrouteId = std::numeric_limits<uint64_t>::max();
/// \brief The route is composed of one or several subroutes. Every subroute is composed of segments.
/// For every Segment is kept some attributes in the structure SegmentInfo.
/**
* @brief A segment of the route.
*
* The route is composed of one or several subroutes. Every subroute is composed of segments.
*
* For every Segment, some attributes are kept in the `SegmentInfo` structure.
*
* @todo the statement regarding `SegmentInfo` seems to be outdated, is `SegmentInfo` a prececessor
* of `RouteSegment`?
*
* Segment data which is actually related to a point, such as junction, distance and time, refer to
* the end which is closer to the end of the route. For the first segment, distance and time are the
* length and travel time of the segment itself. For the last segment, distance and time are the
* length and travel time of the entore route, and the junction is the finish point.
*/
class RouteSegment final
{
public: