route Struct Reference

A complete route. More...

Data Fields
NAVIT_OBJECT struct mapset *	ms
enum route_path_flags	flags
struct route_info *	pos
GList *	destinations
int	reached_destinations_count
struct route_info *	current_dst
struct route_graph *	graph
struct route_path *	path2
struct map *	map
struct map *	graph_map
struct callback *	route_graph_done_cb
struct callback *	route_graph_flood_done_cb
struct callback_list *	cbl2
int	destination_distance
struct vehicleprofile *	vehicleprofile
int	route_status
int	link_path
struct pcoord	pc
struct vehicle *	v

Detailed Description

A complete route.

This struct holds all information about a route.

Field Documentation

cbl2

struct callback_list* route::cbl2

Callback list to call when route changes

Referenced by route_add_attr(), route_dup(), route_remove_attr(), and route_set_attr().

current_dst

struct route_info* route::current_dst

Current destination

destination_distance

int route::destination_distance

Distance to the destination at which the destination is considered "reached"

Referenced by route_dup().

destinations

GList* route::destinations

Destinations of the route

Referenced by rm_attr_get(), rm_get_item(), route_clear_destinations(), route_get_attr(), and route_get_selection().

flags

enum route_path_flags route::flags

Referenced by route_dup().

graph

struct route_graph* route::graph

Pointer to the route graph

Referenced by route_add_traffic_distortion(), route_change_traffic_distortion(), route_destroy(), route_get_graph(), route_has_graph(), route_recalculate_partial(), route_remove_traffic_distortion(), rp_get_item(), and rp_rect_new().

graph_map

struct map* route::graph_map

The map containing the route graph

Referenced by route_destroy(), and route_get_flags().

link_path

int route::link_path

Link paths over multiple waypoints together

map

struct map* route::map

The map containing the route path

Referenced by route_destroy(), and route_get_map().

ms

NAVIT_OBJECT struct mapset* route::ms

The mapset this route is built upon

Referenced by route_dup().

path2

struct route_path* route::path2

Pointer to the route path

Referenced by rm_rect_new(), route_destroy(), and route_get_attr().

pc

struct pcoord route::pc

Referenced by route_get_attr().

pos

struct route_info* route::pos

Current position within this route

Referenced by rm_get_item(), route_destroy(), and route_get_selection().

reached_destinations_count

int route::reached_destinations_count

Used as base to calculate waypoint numbers

Referenced by rm_attr_get().

route_graph_done_cb

struct callback* route::route_graph_done_cb

Callback when route graph is done

route_graph_flood_done_cb

struct callback* route::route_graph_flood_done_cb

Callback when route graph flooding is done

route_status

int route::route_status

Route Status

Referenced by rm_rect_destroy(), route_get_attr(), and route_set_attr().

v

struct vehicle* route::v

Referenced by route_get_attr(), route_remove_attr(), and route_set_attr().

vehicleprofile

struct vehicleprofile* route::vehicleprofile

Routing preferences

Referenced by rm_attr_get(), route_add_traffic_distortion(), route_change_traffic_distortion(), route_dup(), route_get_attr(), route_get_selection(), route_recalculate_partial(), route_remove_traffic_distortion(), and rp_attr_get().

---

The documentation for this struct was generated from the following file:

• route.c