CartoTypeRouter.h File Reference

#import <CartoType/CartoTypeBase.h>

Go to the source code of this file.

Classes
class	CartoTypeRouteProfile
class	CartoTypeTurn
class	CartoTypeNearestRoadInfo
class	CartoTypeLocationMatchParam
class	CartoTypeRoutePoint
class	CartoTypeRouteCoordSet
class	CartoTypePointSet
struct	CartoTypeNavigationData
struct	CartoTypeNearestSegmentinfo
class	CartoTypeRouteSegment
class	CartoTypeRoute
struct	CartoTypeTrafficInfo
struct	CartoTypeLocationRef
class	CartoTypeNavigatorParam
class	CartoTypeTimeAndDistanceMatrix

Enumerations
enum	CartoTypeRouteProfileType {   CarProfile , WalkingProfile , BicycleProfile , HikingProfile ,   SkiProfile }
enum	CartoTypeRouterType {   RouterTypeDefault , RouterTypeStandardAStar , RouterTypeTurnExpandedAStar , RouterTypeStandardContractionHierarchy ,   RouterTypeTECH }
enum	CartoTypeTurnType {   TurnTypeNone , TurnTypeAhead , TurnTypeBearRight , TurnTypeRight ,   TurnTypeSharpRight , TurnTypeAround , TurnTypeSharpLeft , TurnTypeLeft ,   TurnTypeBearLeft }
enum	CartoTypeRoundaboutState { RoundaboutStateNone , RoundaboutStateEnter , RoundaboutStateContinue , RoundaboutStateExit }
enum	CartoTypeSideOfRoad { SideOfRoadNone , SideOfRoadRight , SideOfRoadLeft , SideOfRoadBoth }
enum	CartoTypeNavigationState {   NoNavigationState , NoPositionNavigationState , TurnNavigationState , OffRouteNavigationState ,   RoutingNavigationState , NewRouteNavigationState , TurnRoundNavigationState , ArrivalNavigationState }
enum	CartoTypeFollowMode {   FollowModeNone = 0 , FollowModeLocation = KFollowFlagLocation , FollowModeLocationHeading = KFollowFlagLocation | KFollowFlagHeading , FollowModeLocationZoom = KFollowFlagLocation | KFollowFlagZoom ,   FollowModeLocationHeadingZoom = KFollowFlagLocation | KFollowFlagHeading | KFollowFlagZoom }
enum	CartoTypeRoadOrientation { RoadOrientationNone , RoadOrientationForwards , RoadOrientationBackwards , RoadOrientationBoth }
enum	CartoTypeLocationRefType {   LocationRefLine , LocationRefGeoCoordinate , LocationRefPointAlongLine , LocationRefPointWithAccessPoint ,   LocationRefCircle , LocationRefRectangle , LocationRefPolygon , LocationRefClosedLine }

Detailed Description

Constants, types and interfaces used by routing and navigation.

Enumeration Type Documentation

CartoTypeFollowMode

enum CartoTypeFollowMode

Flags controlling the way the map follows the user location and heading and automatically zooms.

Enumerator
FollowModeNone	The map does not follow the user's location or heading.
FollowModeLocation	The map is centred on the user's location.
FollowModeLocationHeading	The map is centred on the user's location and rotated to the user's heading.
FollowModeLocationZoom	The map is centred on the user's location and zoomed to a suitable level for the user's speed.
FollowModeLocationHeadingZoom	The map is centred on the user's location, rotated to the user's heading, and zoomed to a suitable level for the user's speed.

CartoTypeLocationRefType

enum CartoTypeLocationRefType

The type of a location reference used for traffic information.

Enumerator
LocationRefLine	A line in the route network.
LocationRefGeoCoordinate	A point on the earth's surface.
LocationRefPointAlongLine	A point on a line in the route network.
LocationRefPointWithAccessPoint	A point on the route network providing access to a nearby POI: the first point is the point on the line, the second is the POI.
LocationRefCircle	A circle defined as a point and a radius.
LocationRefRectangle	A rectangle aligned to the grid of latitude and longitude: it is defined using two points at opposite corners.
LocationRefPolygon	A polygon defined using a set of points.
LocationRefClosedLine	A closed line in the route network.

CartoTypeNavigationState

enum CartoTypeNavigationState

States of the navigation system.

Enumerator
NoNavigationState	No route has been created, or navigation is disabled.
NoPositionNavigationState	There is a route but no position has been supplied.
TurnNavigationState	There is a turn ahead.
OffRouteNavigationState	The current position is off the route.
RoutingNavigationState	A route is being calculated.
NewRouteNavigationState	A new route has been calculated.
TurnRoundNavigationState	The latest position is on the route but a U-turn is needed.
ArrivalNavigationState	The latest position is on the route and very close to the destination.

CartoTypeRoadOrientation

enum CartoTypeRoadOrientation

The orientation of a path along a road: used in traffic information.

CartoTypeRoundaboutState

enum CartoTypeRoundaboutState

Turns involving roundabouts are marked as such so that exit numbers can be counted

Enumerator
RoundaboutStateNone	This junction does not involve a roundabout.
RoundaboutStateEnter	This junction enters a roundabout.
RoundaboutStateContinue	This junction continues around a roundabout.
RoundaboutStateExit	This junction exits a roundabout.

CartoTypeRouteProfileType

enum CartoTypeRouteProfileType

Constants used to select frequently-used route profiles.

Enumerator
CarProfile	A profile type for private car navigation.
WalkingProfile	A profile type for walking.
BicycleProfile	A profile type for cycling.
HikingProfile	A profile type for walking, preferring off-road paths.
SkiProfile	A profile type for downhill skiing.

CartoTypeRouterType

enum CartoTypeRouterType

Types of router; used when selecting a router type.

Enumerator
RouterTypeDefault	This router type causes the default router to be selected: the one for which serialized data is available in the map file, or, failing that, RouterTypeStandardAStar.
RouterTypeStandardAStar	The A* router, which gives fast performance but takes a lot of memory and cannot create a route going twice through the same junction.
RouterTypeTurnExpandedAStar	A version of the A* router with road nodes and turn arcs; slower than RouterTypeStandardAStar, and uses more memory, but can generate routes going twice through the same junction, for more flexible routing.
RouterTypeStandardContractionHierarchy	The contraction hierarchy router is intended where less RAM is available: for example with large maps on mobile devices. It gives the same routes as RouterTypeStandardAStar, but is a little slower and does not support custom route profiles; the route profile is decided at the time of creating the CTM1 file.
RouterTypeTECH	Turn-expanded contraction hierarchy.

CartoTypeSideOfRoad

enum CartoTypeSideOfRoad

The side of the road: used in traffic information.

CartoTypeTurnType

enum CartoTypeTurnType

Turn types on a route. Turns at junctions are classified by dividing the full circle into 45-degree segments, except for sharp turns left and right, which encompass everything up to an actual U-turn, and left and right forks, for which there are special rules to avoid classifying them as ahead.

The actual turn angle is also given in the CartoTypeTurn class.

Enumerator
TurnTypeNone	No turn exists or is needed. This turn type is used at the start of a route.
TurnTypeAhead	A turn of less than 22.5 degrees left or right, unless this is a fork with two choices, in which case the turn will be bear right or bear left.
TurnTypeBearRight	A turn between 22.5 degrees and 67.5 degrees right or a turn through a smaller angle which is the rightmost of a fork with two choices.
TurnTypeRight	A turn between 67.5 degrees and 112.5 degrees right.
TurnTypeSharpRight	A turn between 112.5 degrees and 180 degrees right.
TurnTypeAround	This turn type is use for U-turns: turns back along the same road.
TurnTypeSharpLeft	A turn between 112.5 degrees and 180 degrees left.
TurnTypeLeft	A turn between 67.5 degrees and 112.5 degrees left.
TurnTypeBearLeft	A turn between 22.5 degrees and 67.5 degrees left. or a turn through a smaller angle which is the leftmost of a fork with two choices.