Information about an entire route. More...

#include <CartoTypeWrapper.h>

Inheritance diagram for CartoType::Route:

Public Member Functions
RouteSegment ^	RouteSegment (int aIndex)
	Returns a route segment.

NearestSegmentInfo ^	NearestSegment (double aX, double aY, int aSection, double aPreviousDistanceAlongRoute)
	Returns information about the nearest route segment to a point given in map coordinates. More...

NearestSegmentInfo ^	PointAtDistance (double aDistanceInMeters)
	Returns information about a point a certain distance along a route.

NearestSegmentInfo ^	PointAtTime (double aTimeInSeconds)
	Returns information about a point a certain estimated time along a route.

virtual int	ContourCount ()
	Returns the number of contours (sub-paths). More...

virtual int	PointCount (int aContourIndex)
	Returns the number of points in a contour. More...

virtual PathPoint ^	Point (int aContourIndex, int aPointIndex)
	Returns a point given its contour and point indexes. More...

int	ContourCount ()
	Returns the number of contours (sub-paths). More...

int	PointCount (int aContourIndex)
	Returns the number of points in a contour. More...

PathPoint ^	Point (int aContourIndex, int aPointIndex)
	Returns a point given its contour and point indexes. More...

Properties
Geometry^	Geometry `[get]`
	The geometry of the route.

RouteProfile^	Profile `[get]`
	The profile used to create this route.

double	Distance `[get]`
	The distance of the route in metres.

double	Time `[get]`
	The estimated time taken to traverse the route in seconds.

int	RouteSegmentCount `[get]`
	The number of route segments.

double	TollRoadDistance `[get]`
	Returns the total distance in metres of the parts of the route that are on toll roads.

Detailed Description

Information about an entire route.

Member Function Documentation

◆ ContourCount()

virtual int CartoType::Route::ContourCount ( )

virtual

Returns the number of contours (sub-paths).

Implements CartoType::Path.

◆ NearestSegment()

NearestSegmentInfo ^ CartoType::Route::NearestSegment	(	double	aX,
		double	aY,
		int	aSection,
		double	aPreviousDistanceAlongRoute
	)

Returns information about the nearest route segment to a point given in map coordinates.

The parameter aSection gives the current route section (a part of the route between waypoints; simple routes have a single section). The returned segment will always be in the current section or a following section. It is theoretically possible for a section to be completely skipped if it is very short or of zero length, so there is no constraint that section 0 must be followed by section 1 and not by section 2, etc. If aSection is negative it is ignored and the returned segment may be in any section.

The parameter aPreviousDistanceAlongRoute should be provided (set to a value greater than zero) for multi-section routes, so that the correct route segment can be chosen if the route doubles back on itself. Positions further along the route will be given preference over those earlier in the route.