CtRouteSegment Class Reference

#include <CartoTypeRouter.h>

Inheritance diagram for CtRouteSegment:

Instance Methods
(id)	- initWithRouteSegmentObject:
(CtFeatureInfo *)	- featureInfo
(NSString *)	- name
(NSString *)	- ref
(NSString *)	- destination
(double)	- distance
(double)	- time
(double)	- turnTime
(CtTurnType)	- turnType
(bool)	- isContinue
(CtRoundaboutState)	- roundaboutState
(double)	- turnAngle
(int)	- exitNumber
(int)	- choices
(int)	- contourCount
(int)	- pointCount:
(CtPathPoint)	- point:pointIndex:
(int)	- section
(NSString *)	- instructions

Detailed Description

A route segment. All segments except the first start at a turn (a junction).

Method Documentation

choices

- (int) choices

Returns the number of choices at this turning if known; 0 if not known.

contourCount

- (int) contourCount

Returns the number of contours (sub-paths) in the path.

Reimplemented from <CtPath>.

destination

- (NSString *) destination

The destination of the road.

distance

- (double) distance

Returns the distance of the segment in meters.

exitNumber

- (int) exitNumber

Returns the exit number, counting the current junction as 0, if the junction at the start of the segment is part of a roundabout.

featureInfo

- (CtFeatureInfo *) featureInfo

The road type.

initWithRouteSegmentObject:

- (id) initWithRouteSegmentObject:

(void *)

aRouteSegmentObject

Initializes a CtRouteSegment with a C++ route segment object; for internal use only.

instructions

- (NSString *) instructions

Returns turn instructions provided by the routing system. If not empty they are used instead of instructions generated from the information in this CtRouteSegment object.

isContinue

- (bool) isContinue

Returns true if this is a 'continue' turn, false if not.

name

- (NSString *) name

The road name.

point:pointIndex:

- (CtPathPoint) point:		(int)	aContourIndex
pointIndex:		(int)	aPointIndex

Returns a point, given its contour index and point index.

Reimplemented from <CtPath>.

pointCount:

- (int) pointCount:

(int)

aContourIndex

Returns the number of points in a certain contour.

Reimplemented from <CtPath>.

ref

- (NSString *) ref

The road reference.

roundaboutState

- (CtRoundaboutState) roundaboutState

Returns the roundabout state.

section

- (int) section

Returns the route section this route segment belongs to.

time

- (double) time

Returns the estimated time taken to traverse the segment in seconds, including the turn time returned by the turnTime method.

turnAngle

- (double) turnAngle

Returns the turn angle.

turnTime

- (double) turnTime

Returns the estimated time in seconds for the turn at the start of the segment; this is included in the value returned by the time method.

turnType

- (CtTurnType) turnType

Returns the turn type.

---

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

• CartoTypeRouter.h