diff options
| -rw-r--r-- | navit/route.c | 30 |
1 files changed, 21 insertions, 9 deletions
diff --git a/navit/route.c b/navit/route.c index c67455902..fcbbb4d13 100644 --- a/navit/route.c +++ b/navit/route.c @@ -137,13 +137,19 @@ struct size_weight_limit { #define RSD_DANGEROUS_GOODS(x) *((int *)route_segment_data_field_pos((x), attr_vehicle_dangerous_goods)) +/** + * @brief Data for a segment in the route graph + */ struct route_graph_segment_data { - struct item *item; - int offset; - int flags; - int len; - int maxspeed; - struct size_weight_limit size_weight; + struct item *item; /**< The item which this segment is part of */ + int offset; /**< If the item passed in "item" is segmented (i.e. divided + * into several segments), this indicates the position of + * this segment within the item */ + int flags; /**< Flags for this segment */ + int len; /**< The length of this segment */ + int maxspeed; /**< The maximum speed allowed on this segment in km/h, + * -1 if not known */ + struct size_weight_limit size_weight; /**< Size and weight limits for this segment */ int dangerous_goods; }; @@ -1607,6 +1613,15 @@ route_segment_data_size(int flags) } +/** + * @brief Checks if the route graph already contains a particular segment. + * + * This function compares the item IDs of both segments. If the item is segmented, the segment offset is + * also compared. + * + * @param start The starting point of the segment + * @param data The data for the segment + */ static int route_graph_segment_is_duplicate(struct route_graph_point *start, struct route_graph_segment_data *data) { @@ -1629,9 +1644,6 @@ route_graph_segment_is_duplicate(struct route_graph_point *start, struct route_g /** * @brief Inserts a new segment into the route graph * - * This function performs a check if a segment for the item specified already exists, and inserts - * a new segment representing this item if it does not. - * * @param this The route graph to insert the segment into * @param start The graph point which should be connected to the start of this segment * @param end The graph point which should be connected to the end of this segment |