mirror of
https://codeberg.org/comaps/comaps
synced 2025-12-20 05:13:58 +00:00
Documentation
Signed-off-by: mvglasow <michael -at- vonglasow.com>
This commit is contained in:
@@ -9,14 +9,16 @@
|
||||
|
||||
namespace routing
|
||||
{
|
||||
// This is directed road segment used as vertex in index graph.
|
||||
//
|
||||
// You can imagine the segment as a material arrow.
|
||||
// Head of each arrow is connected to fletchings of next arrows with invisible links:
|
||||
// these are the edges of the graph.
|
||||
//
|
||||
// Position of the segment is a position of the arrowhead: GetPointId(true).
|
||||
// This position is used in heuristic and edges weight calculations.
|
||||
/**
|
||||
* @brief A directed road segment used as a vertex in the index graph.
|
||||
*
|
||||
* You can imagine the segment as a material arrow.
|
||||
* Head of each arrow is connected to fletchings of next arrows with invisible links:
|
||||
* these are the edges of the graph.
|
||||
*
|
||||
* Position of the segment is a position of the arrowhead: GetPointId(true).
|
||||
* This position is used in heuristic and edges weight calculations.
|
||||
*/
|
||||
class Segment final
|
||||
{
|
||||
public:
|
||||
@@ -82,7 +84,9 @@ public:
|
||||
bool operator<(SegmentEdge const & edge) const;
|
||||
|
||||
private:
|
||||
// Target is vertex going to for outgoing edges, vertex going from for ingoing edges.
|
||||
/**
|
||||
* @brief Vertex going to for outgoing edges, vertex going from for ingoing edges.
|
||||
*/
|
||||
Segment m_target;
|
||||
RouteWeight m_weight;
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user