deCartaRouteInstruction Class Reference
[Route Calculations]

A user instruction for turn-by-turn navigation. More...

#import <deCartaRouteInstruction.h>

List of all members.

Properties

NSString * duration
deCartaLengthdistance
NSString * instruction
deCartaPositionposition
NSString * tour

Detailed Description

A user instruction for turn-by-turn navigation.

For turn-by-turn navigation, each maneuver along a route is described by a deCartaRouteInstruction, which contains an instruction understandable by human beings, as well as information about that instruction for the application to use when presenting the instruction to the user.


Property Documentation

- (deCartaLength*) distance [read, write, retain]

The surface distance covered in this route maneuver. The distance is a string representing a floating point number. Example, "3.3". (Units of measure are defined within the deCartaLength class)

- (NSString*) duration [read, write, retain]

The time estimated to cover this route maneuver, written as a fully described string. Example, "2 minutes 31 seconds"

- (NSString*) instruction [read, write, retain]

A human readable description of this route maneuver. Example: "Turn right on Main Street." The instructions will almost always contain a relative directional action (like "Turn right...") followed by the information defining the destination (like "...on Main Street").

- (deCartaPosition*) position [read, write, retain]

The latitude and longitude coordinate at which the maneuver happens.

- (NSString*) tour [read, write, retain]

A string indicating the waypoint number that this instruction is associated with in an optimized route, if any. 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" means that this maneuver is associated with the second waypoint. Note: the origin and destination are not considered waypoints, and are not referred to by this field. Only the waypoints between the origin and destination count as waypoints.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Properties

Generated on Fri Aug 12 16:23:01 2011 for deCarta iPhone API by  doxygen 1.6.1