A navigable route from one map location to another, with route meta-data. More...
#import <deCartaRoute.h>
Public Member Functions | |
| (NSString *) | - getSummary |
Properties | |
| deCartaBoundingBox * | boundingBox |
| NSString * | totalTime |
| deCartaLength * | totalDistance |
| NSString * | viaPointSequence |
| NSMutableArray * | routeInstructions |
| NSMutableArray * | routeGeometry |
| NSString * | routeId |
A navigable route from one map location to another, with route meta-data.
The deCartaRoute class is used to encapsulate all information needed to describe a route calculated by the deCarta DDS Web Services.
| - (NSString *) getSummary |
Provides a route summary providing route distance and travel time.
- (deCartaBoundingBox*) boundingBox [read, write, retain] |
Bounding box around the geometry of the route
- (NSMutableArray*) routeGeometry [read, write, retain] |
Array of deCartaPosition objects that fully describe the geometry of the route. Note: geometry is only returned when the route request is made through a deCartaRouteQuery request. Long routes can produces tens of thousands of deCartaPosition objects.
- (NSString*) routeId [read, write, retain] |
A unique string for identifying this route by name.
- (NSMutableArray*) routeInstructions [read, write, retain] |
Array of deCartaRouteInstruction instances. Each RouteInstruction describes one specific maneuver along the route.
- (deCartaLength*) totalDistance [read, write, retain] |
A text summary of the total surface distance traveled along the entire route. (Units of measure are defined within the deCartaLength class)
- (NSString*) totalTime [read, write, retain] |
A text summary of the estimated travel time of the entire route. Example, "Total Time: 2 minutes 31 seconds"
- (NSString*) viaPointSequence [read, write, retain] |
A comma delimited string used to identify the order in which the waypoints are visited in an optimized route. When a multipoint route is optimized the order of the waypoints can be different than the way you entered them. The waypoints are referred in zero-based array order (e.g. '0' is actually the first waypoint). Example, "1,0" means the second waypoint was visited first, followed by the first waypoint. Note: the origin and destination are not considered waypoints, and are not referred to by this field. Only the points between the origin and destination count as waypoints.
1.6.1
