CartoType iOS API 7.8.2, 2022-03-25
for development in Swift and Objective C for iOS and Mac OS
Instance Methods | List of all members
CartoTypeRouteSegment Class Reference

#import <CartoTypeRouter.h>

Inheritance diagram for CartoTypeRouteSegment:
<CartoTypePath>

Instance Methods

(id) - initWithRouteSegmentObject:
 
(void) - dealloc
 
(CartoTypeRoadType- getRoadType
 
(double) - getMaxSpeed
 
(NSString *) - getName
 
(NSString *) - getRef
 
(double) - getDistance
 
(double) - getTime
 
(double) - getTurnTime
 
(CartoTypeTurnType- getTurnType
 
(bool) - getContinue
 
(CartoTypeRoundaboutState- getRoundaboutState
 
(double) - getTurnAngle
 
(int) - getExitNumber
 
(int) - getChoices
 
(int) - contourCount
 
(int) - pointCount:
 
(CartoTypePathPoint- point:pointIndex:
 
(int) - getSection
 
(int) - contourCount
 
(int) - pointCount:
 
(CartoTypePathPoint- point:pointIndex:
 

Detailed Description

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

Method Documentation

◆ contourCount

- (int) contourCount

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

Reimplemented from <CartoTypePath>.

◆ dealloc

- (void) dealloc

Destroys the object.

◆ getChoices

- (int) getChoices

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

◆ getContinue

- (bool) getContinue

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

◆ getDistance

- (double) getDistance

Gets the distance of the segment in meters.

◆ getExitNumber

- (int) getExitNumber

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

◆ getMaxSpeed

- (double) getMaxSpeed

Gets the maximum speed in kilometers per hour, or 0 if no maximum speed is known.

◆ getName

- (NSString *) getName

Gets the standard name of the object of which this segment is a part.

◆ getRef

- (NSString *) getRef

Gets the road reference of the object of which this segment is a part.

◆ getRoadType

- (CartoTypeRoadType) getRoadType

Gets the road type of the object of which this segment is a part.

◆ getRoundaboutState

- (CartoTypeRoundaboutState) getRoundaboutState

Gets the roundabout state.

◆ getSection

- (int) getSection

Gets the route section this route segment belongs to.

◆ getTime

- (double) getTime

Gets the estimated time taken to traverse the segment in seconds, including the turn time return by getTurnTime.

◆ getTurnAngle

- (double) getTurnAngle

Gets the turn angle.

◆ getTurnTime

- (double) getTurnTime

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

◆ getTurnType

- (CartoTypeTurnType) getTurnType

Gets the turn type.

◆ initWithRouteSegmentObject:

- (id) initWithRouteSegmentObject: (void *)  aRouteSegmentObject

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

◆ point:pointIndex:

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

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

Reimplemented from <CartoTypePath>.

◆ pointCount:

- (int) pointCount: (int)  aContourIndex

Gets the number of points in a certain contour.

Reimplemented from <CartoTypePath>.


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