Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
Routes & Navigation

Routes & Navigation related interfaces. More...

Classes

struct  gem::AlarmMonitoredArea
 Alarm monitored area. More...
class  gem::IAlarmListener
 Alarm listener interface. More...
class  gem::AlarmService
 AlarmService object. More...
class  gem::IGeofenceListener
 Geofence service listener. More...
struct  gem::GeofenceArea
 Geofence area. More...
struct  gem::GeofenceProximityArea
 Proximity geofence area result. More...
class  gem::Geofence
 Geofence object. More...
struct  gem::AbstractGeometryImageRenderSettings
 Abstract geometry image render settings. More...
class  gem::AbstractGeometryImage
 AbstractGeometryImage object. More...
struct  gem::SignpostImageRenderSettings
 Signpost image render settings. More...
class  gem::SignpostImage
 Signpost image object. More...
struct  gem::RoadInfoImageRenderSettings
 Road info image render settings. More...
class  gem::RoadInfoImage
 Road info image object. More...
struct  gem::LaneImageRenderSettings
 Lane image render settings. More...
class  gem::LaneImage
 Lane image object. More...
struct  gem::NextSpeedLimit
 Next speed limit info. More...
class  gem::AbstractGeometryItem
 AbstractGeometryItem object. More...
class  gem::AbstractGeometry
 AbstractGeometry object. More...
class  gem::TurnDetails
 TurnDetails object. More...
class  gem::RoadInfo
 RoadInfo object. More...
class  gem::SignpostItem
 SignpostItem object. More...
class  gem::SignpostDetails
 SignpostDetails object. More...
class  gem::NavigationInstruction
 NavigationInstruction object. More...
class  gem::INavigationListener
 Navigation listener interface. More...
class  gem::NavigationService
 Core navigation engine. More...
class  gem::IRouteListener
 Route listener interface. More...
struct  gem::VehicleRegistration
 Vehicle registration data. More...
struct  gem::MotorVehicleProfile
 Motor vehicle profile. More...
struct  gem::CarProfile
 Car routing profile. More...
struct  gem::TruckProfile
 Truck routing profile. More...
struct  gem::EVCarModel
 EV car model. More...
struct  gem::EVProfile
 EV routing profile. More...
struct  gem::ElectricBikeProfile
 eBike profile More...
class  gem::RoutePreferences
 RoutePreferences object. More...
struct  gem::ClimbSection
 Climb section structure. More...
struct  gem::SurfaceSection
 Surface section structure Sections list is in route begin -> end walk order. More...
struct  gem::RoadTypeSection
 Road type sections structure Sections list is in route begin -> end walk order. More...
struct  gem::SteepSection
 Steep section structure Sections list is in route begin -> end walk order. More...
struct  gem::TollSection
 Toll section structure. More...
class  gem::PTTranslation
 PTTranslation object. More...
class  gem::PTAlert
 PTAlert object. More...
class  gem::RouteTerrainProfile
 RouteTerrainProfile object. More...
class  gem::RouteInstructionBase
 RouteInstructionBase object. More...
class  gem::PTRouteInstruction
 PTRouteInstruction object. More...
class  gem::EVRouteInstruction
 EVRouteInstruction object. More...
class  gem::RouteInstruction
 RouteInstruction object. More...
class  gem::RouteSegmentBase
 RouteSegmentBase object. More...
class  gem::PTRouteSegment
 PTRouteSegment object. More...
class  gem::EVRouteSegment
 EVRouteSegment object. More...
class  gem::RouteSegment
 RouteSegment object. More...
class  gem::PTBuyTicketInformation
 PTBuyTicketInformation object. More...
class  gem::RouteBase
 RouteBase object. More...
class  gem::PTRoute
 PTRoute object. More...
class  gem::EVRoute
 EVRoute object. More...
class  gem::OTRoute
 Over track route object. More...
class  gem::Route
 Route object. More...
class  gem::MapViewRoute
 MapViewRoute object. More...
class  gem::RoutingService
 RoutingService object. More...
class  gem::RouteBookmarks
 RouteBookmarks object. More...
class  gem::RouteCollection
 RouteCollection object. More...
class  gem::MapViewRouteCollection
 MapViewRouteCollection object. More...
struct  gem::UserRoadblockPathPreviewCoordinate
 User roadblock path preview match info. More...
class  gem::TrafficEvent
 TrafficEvent object. More...
class  gem::RouteTrafficEvent
 RouteTrafficEvent object. More...
class  gem::IPersistentRoadblockListener
 Persistent roadblock listener interface. More...
class  gem::TrafficPreferences
 TrafficPreferences object. More...
class  gem::TrafficService
 TrafficService object. More...
struct  gem::TimeDistance
 Time distance representation based on meters and seconds. More...

Typedefs

using gem::AlarmListener = Listener<IAlarmListener>
 AlarmListener wrapper class.
using gem::AbstractGeometryItemList = List<AbstractGeometryItem>
 List of AbstractGeometryItem objects.
using gem::AbstractGeometryItemListRef = const ApiRef<AbstractGeometryItemList>
 Const reference to AbstractGeometryItemList.
using gem::SignpostItemList = List<SignpostItem>
 List of SignpostItem objects.
using gem::SignpostItemListRef = ApiRef<SignpostItemList>
 Reference to list of SignpostItem objects.
using gem::RoadInfoList = List<RoadInfo>
 List of RoadInfo objects.
using gem::RoadInfoListRef = ApiRef<RoadInfoList>
 Reference to RoadInfoList.
using gem::RouteList = List<Route>
 List of Route objects.
using gem::RouteListRef = ApiRef<RouteList>
 Reference to list of Route objects.
using gem::RouteSegmentList = List<RouteSegment>
 List of RouteSegment objects.
using gem::EVCarModelList = List<EVCarModel>
 List of EVCarModel entities.
using gem::RouteInstructionList = List<RouteInstruction>
 List of RouteInstruction objects.
using gem::ClimbSectionList = List<ClimbSection>
 List of ClimbSection entities.
using gem::SurfaceSectionList = List<SurfaceSection>
 List of SurfaceSection entities.
using gem::RoadTypeSectionList = List<RoadTypeSection>
 List of RoadTypeSection entities.
using gem::SteepSectionList = List<SteepSection>
 List of SteepSection entities.
using gem::TollSectionList = List<TollSection>
 List of TollSection entities.
using gem::TrafficEventList = List<TrafficEvent>
 List of TrafficEvent objects.
using gem::TrafficEventListRef = ApiRef<TrafficEventList>
 Reference to list of TrafficEvent objects.
using gem::RouteTrafficEventList = List<RouteTrafficEvent>
 List of RouteTrafficEvent objects.
using gem::GeofenceListener = Listener<IGeofenceListener>
 IGeofenceListener wrapper class.
using gem::AbstractGeometryImageRef = ApiRef<AbstractGeometryImage>
 Reference to AbstractGeometryImage.
using gem::SignpostImageRef = ApiRef<SignpostImage>
 Reference to SignpostImage.
using gem::RoadInfoImageRef = ApiRef<RoadInfoImage>
 Reference to RoadInfoImage.
using gem::LaneImageRef = ApiRef<LaneImage>
 Reference to LaneImage.
using gem::AbstractGeometryRef = ApiRef<AbstractGeometry>
 Reference to AbstractGeometry.
using gem::TurnDetailsRef = ApiRef<TurnDetails>
 Reference to TurnDetails.
using gem::SignpostDetailsRef = ApiRef<SignpostDetails>
 Reference to SignpostDetails.
using gem::NavigationInstructionRef = ApiRef<NavigationInstruction>
 Reference to NavigationInstruction.
using gem::NavigationListener = Listener<INavigationListener>
 INavigationListener wrapper class.
using gem::RouteListener = Listener<IRouteListener>
 IRouteListener wrapper class.
using gem::RoutePreferencesRef = ApiRef<RoutePreferences>
 Reference to RoutePreferences.
using gem::PTTranslationRef = ApiRef<PTTranslation>
 Reference to PTTranslation.
using gem::PTAlertRef = ApiRef<PTAlert>
 Reference to PTAlert.
using gem::RouteTerrainProfileRef = ApiRef<RouteTerrainProfile>
 Reference to RouteTerrainProfile.
using gem::PTRouteInstructionRef = ApiRef<PTRouteInstruction>
 Reference to PTRouteInstruction.
using gem::EVRouteInstructionRef = ApiRef<EVRouteInstruction>
 Reference to EVRouteInstruction.
using gem::RouteInstructionRef = ApiRef<RouteInstruction>
 Reference to RouteInstruction.
using gem::PTRouteSegmentRef = ApiRef<PTRouteSegment>
 Reference to PTRouteSegment.
using gem::EVRouteSegmentRef = ApiRef<EVRouteSegment>
 Reference to PTRouteSegment.
using gem::PTBuyTicketInformationRef = ApiRef<PTBuyTicketInformation>
 Reference to PTBuyTicketInformation.
using gem::PTRouteRef = ApiRef<PTRoute>
 Reference to PTRoute.
using gem::EVRouteRef = ApiRef<EVRoute>
 Reference to EVRoute.
using gem::OTRouteRef = ApiRef<OTRoute>
 Reference to over track route.
using gem::RouteRef = ApiRef<Route>
 Reference to Route.
using gem::RouteCollectionRef = ApiRef<RouteCollection>
 Reference to RouteCollection.
using gem::MapViewRouteCollectionRef = ApiRef<MapViewRouteCollection>
 Reference to MapViewRouteCollection.
using gem::RoutesCollection = RouteCollection
 Deprecated names.
using gem::RoutesCollectionRef = ApiRef<RouteCollection>
 Reference to a collection of route objects.
using gem::MapViewRoutesCollection = MapViewRouteCollection
 Collection of routes as they appear in a map view context.
using gem::MapViewRoutesCollectionRef = ApiRef<MapViewRouteCollection>
 Reference to a collection of map view routes.
using gem::TrafficEventRef = ApiRef<TrafficEvent>
 Reference to TrafficEvent.
using gem::TrafficPreferencesRef = ApiRef<TrafficPreferences>
 Reference to TrafficPreferences.

Enumerations

enum  gem::ProximityAreaDetails { gem::PAD_Geometry = 0x1 }
 Proximity geofence area result details. More...
enum  gem::EShapeForm { gem::SF_Line , gem::SF_CircleSegment , gem::SF_Point }
 The form of the shape. More...
enum  gem::EShapeType { gem::ST_Route , gem::ST_Street }
 The type of the shape. More...
enum  gem::EArrowType { gem::AR_None , gem::AR_Begin , gem::AR_End }
 The arrow type of the shape. More...
enum  gem::ERestrictionType { gem::RST_None , gem::RST_Direction , gem::RST_Manoeuvre }
 The restriction type of the shape. More...
enum  gem::EArrowDirection { gem::EAD_None , gem::EAD_Left , gem::EAD_Straight , gem::EAD_Right }
 The arrow direction of the shape. More...
enum  gem::EAnchorType { gem::A_Point , gem::A_Circle , gem::A_Waypoint , gem::A_EVWaypoint }
 The anchor type. More...
enum  gem::EDriveSide { gem::DS_Left , gem::DS_Right }
 The drive side of the abstract geometry. More...
enum  gem::ETurnEvent {
  gem::T_NA , gem::T_Straight , gem::T_Right , gem::T_Right1 ,
  gem::T_Right2 , gem::T_Left , gem::T_Left1 , gem::T_Left2 ,
  gem::T_LightLeft , gem::T_LightLeft1 , gem::T_LightLeft2 , gem::T_LightRight ,
  gem::T_LightRight1 , gem::T_LightRight2 , gem::T_SharpRight , gem::T_SharpRight1 ,
  gem::T_SharpRight2 , gem::T_SharpLeft , gem::T_SharpLeft1 , gem::T_SharpLeft2 ,
  gem::T_RoundaboutExitRight , gem::T_Roundabout , gem::T_RoundRight , gem::T_RoundLeft ,
  gem::T_ExitRight , gem::T_ExitRight1 , gem::T_ExitRight2 , gem::T_InfoGeneric ,
  gem::T_DriveOn , gem::T_ExitNr , gem::T_ExitLeft , gem::T_ExitLeft1 ,
  gem::T_ExitLeft2 , gem::T_RoundaboutExitLeft , gem::T_IntoRoundabout , gem::T_StayOn ,
  gem::T_BoatFerry , gem::T_RailFerry , gem::T_InfoLane , gem::T_InfoSign ,
  gem::T_LeftRight , gem::T_RightLeft , gem::T_KeepLeft , gem::T_KeepRight ,
  gem::T_Start , gem::T_Intermediate , gem::T_Stop
}
 Navigation turn events. More...
enum  gem::ERoadShieldType {
  gem::RS_Invalid = 0 , gem::RS_County , gem::RS_State , gem::RS_Federal ,
  gem::RS_Interstate , gem::RS_4 , gem::RS_5 , gem::RS_6 ,
  gem::RS_7
}
 Road shield type. More...
enum  gem::ESignpostItemType {
  gem::SI_Invalid = 0 , gem::SI_PlaceName , gem::SI_RouteNumber , gem::SI_RouteName ,
  gem::SI_ExitNumber , gem::SI_ExitName , gem::SI_Pictogram , gem::SI_OtherDestination
}
 Signpost item type. More...
enum  gem::ESignpostPictogramType {
  gem::SP_Invalid = 0 , gem::SP_Airport , gem::SP_BusStation , gem::SP_FairGround ,
  gem::SP_Ferry , gem::SP_FirstAidPost , gem::SP_Harbour , gem::SP_Hospital ,
  gem::SP_HoteMotel , gem::SP_IndustrialArea , gem::SP_InformationCentre , gem::SP_ParkingFacility ,
  gem::SP_PetrolStation , gem::SP_RailwayStation , gem::SP_RestArea , gem::SP_Restaurant ,
  gem::SP_Toilet
}
 Signpost pictogram type. More...
enum  gem::ESignpostConnectionInfo { gem::SCI_Invalid = 0 , gem::SCI_Branch , gem::SCI_Towards , gem::SCI_Exit }
 Signpost connection info. More...
enum  gem::ENavigationStatus { gem::NS_Running , gem::NS_WaitingRoute , gem::NS_WaitingGPS , gem::NS_WaitingReturnToRoute }
 Navigation states. More...
enum  gem::ENavigationInstructionUpdateEvents { gem::NIUE_NextTurnUpdated = 1 , gem::NIUE_NextTurnImageUpdated = 2 , gem::NIUE_LaneInfoUpdated = 4 }
 Navigation instruction update events. More...
enum  gem::ERouteResultType { gem::RRT_Path , gem::RRT_Range }
 Route result. More...
enum  gem::ERouteType {
  gem::RT_Fastest , gem::RT_Shortest , gem::RT_Economic , gem::RT_Scenic ,
  gem::RT_Matrix
}
 Route type. More...
enum  gem::ERouteTransportMode {
  gem::RTM_Car , gem::RTM_Lorry , gem::RTM_Pedestrian , gem::RTM_Bicycle ,
  gem::RTM_Public
}
 Transport mode. More...
enum  gem::ETrafficAvoidance { gem::TA_None , gem::TA_All , gem::TA_Roadblocks }
 Traffic avoidance options. More...
enum  gem::EPTAlgorithmType { gem::PTAT_Departure , gem::PTAT_Arrival }
 Algorithm type. More...
enum  gem::EPTSortingStrategy { gem::PTSS_Best_Time , gem::PTSS_Least_Walk , gem::PTSS_Least_Transfers }
 Sorting strategy. More...
enum  gem::EPTRouteTypePreference {
  gem::RTP_None = 0x00000000 , gem::RTP_Bus = 0x00000001 , gem::RTP_Underground = 0x00000002 , gem::RTP_Railway = 0x00000004 ,
  gem::RTP_Tram = 0x00000008 , gem::RTP_Water_Transport = 0x00000010 , gem::RTP_Misc = 0x00000020 , gem::RTP_Shared_Bike = 0x00000040 ,
  gem::RTP_Shared_Car = 0x00000080 , gem::RTP_Shared_Scooter = 0x000000100
}
 Route type preference. More...
enum  gem::EBikeProfile { gem::BP_Road , gem::BP_Cross , gem::BP_City , gem::BP_Mountain }
 Bike profile. More...
enum  gem::EEBikeType { gem::EBP_None , gem::EBP_Pedelec , gem::EBP_PowerOnDemand , gem::EBP_SPedelec }
 eBike type More...
enum  gem::EPedestrianProfile { gem::PP_Walk , gem::PP_Hike }
 Pedestrian profile. More...
enum  gem::ERouteResultDetails { gem::RD_Full , gem::RD_TimeDistance , gem::RD_Path }
 Routing result details. More...
enum  gem::ERouteAlternativesSchema { gem::AS_Default , gem::AS_Never , gem::AS_Always }
 Alternative routes scheme. More...
enum  gem::ERoutePathAlgorithm {
  gem::PA_ML , gem::PA_ME = PA_ML , gem::PA_SimplifiedML , gem::PA_ExternalCH ,
  gem::PA_ML_CH
}
 Path calculation algorithm. More...
enum  gem::ERoutePathFlavor { gem::PF_ML , gem::PF_GH }
 Path calculation flavors. More...
enum class  gem::ERangeType { gem::ERangeType::Default , gem::ERangeType::DistanceBased , gem::ERangeType::TimeBased , gem::ERangeType::EnergyBased }
 Unit type to define ranges in. More...
enum  gem::EEmergencyExtraFreedomLevels { gem::EEFL_IgnoreCDM = 0x1 }
 Emergency vehicles extra freedom options. More...
enum  gem::EFuelType { gem::FT_Petrol , gem::FT_Diesel , gem::FT_LPG , gem::FT_Electric }
 Fuel type. More...
enum  gem::EEVChargingConnector {
  gem::EVC_Type1 = 0x001 , gem::EVC_Type2 = 0x002 , gem::EVC_NACS = 0x004 , gem::EVC_CCS1 = 0x008 ,
  gem::EVC_CCS2 = 0x010 , gem::EVC_CHAdeMO = 0x020 , gem::EVC_ChaoJi = 0x040 , gem::EVC_GBT_AC = 0x080 ,
  gem::EVC_GBT_DC = 0x100
}
 Electric vehicle charging port. More...
enum  gem::ERouteBookmarksSortOrder { gem::RBSO_SortByDate , gem::RBSO_SortByName }
 Enumeration used to specify the sort order of the routes. More...
enum  gem::EGrade {
  gem::GradeHC , gem::Grade1 , gem::Grade2 , gem::Grade3 ,
  gem::Grade4
}
 Climb grade - UCI based, see https://bicycles.stackexchange.com/questions/1210/how-are-the-categories-for-climbs-decided Categories are sorted in descending order by difficulty ( EGradeHC - most difficult, EGrade4 - less difficult ). More...
enum  gem::ESurfaceType {
  gem::S_Asphalt , gem::S_Paved , gem::S_Unpaved , gem::S_Unknown ,
  gem::Asphalt = S_Asphalt , gem::Paved = S_Paved , gem::Unpaved = S_Unpaved , gem::Unknown = S_Unknown
}
 Get surface type. More...
enum  gem::ERoadType {
  gem::R_Motorways , gem::R_StateRoad , gem::R_Road , gem::R_Street ,
  gem::R_Cycleway , gem::R_Path , gem::R_SingleTrack
}
 Get road type. More...
enum  gem::GetWaypointsOptions { gem::GW_Initial , gem::GW_RemainingInitial , gem::GW_Remaining }
 Get route waypoints options. More...
enum  gem::ERouteStatus {
  gem::RS_Uninitialized , gem::RS_Calculating , gem::RS_WaitingInternetConnection , gem::RS_Ready ,
  gem::RS_Error
}
 Status of routing service. More...
enum  gem::ETransitType {
  gem::TT_Walk , gem::TT_Bus , gem::TT_Underground , gem::TT_Railway ,
  gem::TT_Tram , gem::TT_WaterTransport , gem::TT_Other , gem::TT_SharedBike ,
  gem::TT_SharedScooter , gem::TT_SharedCar , gem::TT_Unknown
}
 Type of transit. More...
enum  gem::ERealtimeStatus { gem::RS_Delay , gem::RS_OnTime , gem::RS_NotAvailable }
 Status of realtime information. More...
enum  gem::ETrafficEventImpactZone { gem::TEIZ_Path , gem::TEIZ_Area }
 Traffic event shape. More...
enum  gem::ETrafficEventSeverity {
  gem::TES_Stationary = 0 , gem::TES_Queuing , gem::TES_SlowTraffic , gem::TES_PossibleDelay ,
  gem::TES_Unknown , gem::TES_Free
}
 Traffic event severity enum. More...
enum  gem::ETrafficUsage { gem::UseNone , gem::UseOnline , gem::UseOffline }
 Traffic usage type. More...
enum  gem::ETrafficOnlineRestrictions {
  gem::Settings = 1 , gem::Connection = 2 , gem::NetworkType = 4 , gem::ProviderData = 8 ,
  gem::WorldMapVersion = 16 , gem::DiskSpace = 32 , gem::InitFail = 64
}
 Restrictions which prevent online service functionality. More...
enum  gem::ETrafficEventClass {
  gem::TrafficEventBase = 0 , gem::TrafficOther = TrafficEventBase , gem::TrafficLevelOfService , gem::TrafficExpectedLevelOfService ,
  gem::TrafficAccidents , gem::TrafficIncidents , gem::TrafficClosuresAndLaneRestrictions , gem::TrafficCarriagewayRestrictions ,
  gem::TrafficExitRestrictions , gem::TrafficEntryRestrictions , gem::TrafficTrafficRestrictions , gem::TrafficCarpoolInfo ,
  gem::TrafficRoadworks , gem::TrafficObstructionHazards , gem::TrafficDangerousSituations , gem::TrafficRoadConditions ,
  gem::TrafficTemperatures , gem::TrafficPrecipitationAndVisibility , gem::TrafficWindAndAirQuality , gem::TrafficActivities ,
  gem::TrafficSecurityAlerts , gem::TrafficDelays , gem::TrafficCancellations , gem::TrafficTravelTimeInfo ,
  gem::TrafficDangerousVehicles , gem::TrafficExceptionalLoadsOrVehicles , gem::TrafficTrafficEquipmentStatus , gem::TrafficSizeAndWeightLimits ,
  gem::TrafficParkingRestrictions , gem::TrafficParking , gem::TrafficReferenceToAudioBroadcast , gem::TrafficServiceMessages ,
  gem::TrafficSpecialMessages , gem::TrafficUserEventsBase = 100 , gem::TrafficUserRoadblock = TrafficUserEventsBase
}
 Traffic events classes. More...

Detailed Description

Routes & Navigation related interfaces.

Typedef Documentation

◆ AlarmListener

AlarmListener wrapper class.

Keeps a raw pointer or a safe pointer to a IAlarmListener interfaceday

◆ GeofenceListener

IGeofenceListener wrapper class.

Keeps a raw pointer or a safe pointer to a IGeofenceListener interface

◆ NavigationListener

INavigationListener wrapper class.

Keeps a raw pointer or a safe pointer to a INavigationListener interface

◆ RouteListener

IRouteListener wrapper class.

Keeps a raw pointer or a safe pointer to a IRouteListener interface

Enumeration Type Documentation

◆ EAnchorType

The anchor type.

The anchor is a point (all intersections), a circle (roundabout, complex traffic figure) or a waypoint.

Enumerator
A_Point 

Point.

A_Circle 

Circle.

A_Waypoint 

Waypoint.

A_EVWaypoint 

EV charging station waypoint.

◆ EArrowDirection

The arrow direction of the shape.

The arrow direction will be only valid for TShapeForm::ECircleSegment and some combined turns

Enumerator
EAD_None 

None.

EAD_Left 

Left.

EAD_Straight 

Straight.

EAD_Right 

Right.

◆ EArrowType

The arrow type of the shape.

The arrow is either attached to the anchor side EShapeBegin, or the opposite side EShapeEnd.

Enumerator
AR_None 

None.

AR_Begin 

Begin.

AR_End 

End.

◆ EBikeProfile

Bike profile.

Enumerator
BP_Road 

Bike profile - road.

BP_Cross 

Bike profile - cross.

BP_City 

Bike profile - city.

BP_Mountain 

Bike profile - mountain.

◆ EDriveSide

The drive side of the abstract geometry.

Side position relative to the drive direction

Enumerator
DS_Left 

Left to drive direction.

DS_Right 

Right to drive direction.

◆ EEBikeType

eBike type

Enumerator
EBP_None 

eBike type none

EBP_Pedelec 

eBike type pedelec

EBP_PowerOnDemand 

eBike type power-on-demand

EBP_SPedelec 

eBike type S-pedelec

◆ EEmergencyExtraFreedomLevels

Emergency vehicles extra freedom options.

Enumerator
EEFL_IgnoreCDM 

Ignore map defined conditional maneuvers such as prohibited turn left / turn right.

◆ EEVChargingConnector

Electric vehicle charging port.

Enumerator
EVC_Type1 

Type 1 (a.k.a. SAE J1772).

EVC_Type2 

Type 2 (a.a.a. Mennekes).

EVC_NACS 

Tesla "Model S" connector, a.k.a. North American Charging Standard.

EVC_CCS1 

CCS connector with Type-1-compatible AC charging.

EVC_CCS2 

CCS connector with Type-2-compatible AC charging.

EVC_CHAdeMO 

CHAdeMO standard.

EVC_ChaoJi 

ChaoJi standard.

EVC_GBT_AC 

GB/T AC connector.

EVC_GBT_DC 

GB/T DC connector.

◆ EFuelType

Fuel type.

Enumerator
FT_Petrol 

Petrol fuel type.

FT_Diesel 

Diesel fuel type.

FT_LPG 

LPG (Liquid Petroleum Gas) fuel type.

FT_Electric 

Electric fuel type.

◆ EGrade

Climb grade - UCI based, see https://bicycles.stackexchange.com/questions/1210/how-are-the-categories-for-climbs-decided Categories are sorted in descending order by difficulty ( EGradeHC - most difficult, EGrade4 - less difficult ).

Enumerator
GradeHC 

HC.

Grade1 

1

Grade2 

2

Grade3 

3

Grade4 

4

◆ ENavigationInstructionUpdateEvents

Navigation instruction update events.

Enumerator
NIUE_NextTurnUpdated 

Next route turn updated.

NIUE_NextTurnImageUpdated 

Turn image updated.

Even if the next turn doesn't update, the image may change (e.g. intermediates left / right street count before turn )

NIUE_LaneInfoUpdated 

Lane image updated.

◆ ENavigationStatus

Navigation states.

Enumerator
NS_Running 

Running, this is the normal state.

NS_WaitingRoute 

Paused, waiting for route to update ( re-routing enabled case ).

Check navigation route status for details about route update

NS_WaitingGPS 

Paused, waiting for GPS location to recover.

NS_WaitingReturnToRoute 

Paused, waiting to return to the route ( re-routing disabled case ).

◆ EPedestrianProfile

Pedestrian profile.

Enumerator
PP_Walk 

Pedestrian profile - walk.

PP_Hike 

Pedestrian profile - hike.

◆ EPTAlgorithmType

Algorithm type.

Enumerator
PTAT_Departure 

Algorithm type - departure/starting point.

PTAT_Arrival 

Algorithm type - arrival/destination point.

◆ EPTRouteTypePreference

Route type preference.

Enumerator
RTP_None 

No preference regarding route type, unpaved road is good enough.

RTP_Bus 

Prefer buses.

RTP_Underground 

Prefer underground/overground subways/metro and underground railway/tunnel transportation.

RTP_Railway 

Prefer train and coach services.

RTP_Tram 

Prefer trams.

RTP_Water_Transport 

Prefer water transportation (boats, ships, gondolas, water taxis).

RTP_Misc 

Prefer other means of transportation: funicular, telecabins, air transportation, taxis etc.

RTP_Shared_Bike 

Prefer shared bikes.

RTP_Shared_Car 

Prefer shared cars.

RTP_Shared_Scooter 

Prefer shared scooters.

◆ EPTSortingStrategy

Sorting strategy.

Enumerator
PTSS_Best_Time 

Sorting strategy - best time.

PTSS_Least_Walk 

Sorting strategy - least walk.

PTSS_Least_Transfers 

Sorting strategy - fewest transfers.

◆ ERangeType

enum class gem::ERangeType
strong

Unit type to define ranges in.

Currently only used for the roundtrips feature, not the ranges (aka isochrones) feature.

Enumerator
Default 

Uses DistanceBased for route type "shortest" and TimeBased for route type "fastest", for backward compatibility.

DistanceBased 

Range unit is in meters.

TimeBased 

Range unit is in seconds.

EnergyBased 

Range unit is in Watt-Hours (not currently supported for roundtrips).

◆ ERealtimeStatus

Status of realtime information.

Enumerator
RS_Delay 

Delayed.

RS_OnTime 

On time.

RS_NotAvailable 

Not available.

◆ ERestrictionType

The restriction type of the shape.

The restriction type can be used to visualize the restriction for the connected street.

Enumerator
RST_None 

No restriction.

RST_Direction 

Direction restriction.

RST_Manoeuvre 

Manoeuvre restriction.

◆ ERoadShieldType

Road shield type.

Enumerator
RS_Invalid 

Invalid.

RS_County 

Country.

RS_State 

State.

RS_Federal 

Federal.

RS_Interstate 

Interstate.

RS_4 

4

RS_5 

5

RS_6 

6

RS_7 

7

◆ ERoadType

Get road type.

Enumerator
R_Motorways 

Motorway.

R_StateRoad 

State road.

R_Road 

Road.

R_Street 

Street.

R_Cycleway 

Cycleway.

R_Path 

Path.

R_SingleTrack 

Single track.

◆ ERouteAlternativesSchema

Alternative routes scheme.

Enumerator
AS_Default 

Alternative routes scheme - Service default - depending on selected transport, route type & result details.

AS_Never 

Alternative routes scheme - No alternatives.

AS_Always 

Alternative routes scheme - Always ( even if not recommended, e.g. for shortest etc ).

◆ ERouteBookmarksSortOrder

Enumeration used to specify the sort order of the routes.

Enumerator
RBSO_SortByDate 

Sort descending by update time (most recent at top).

RBSO_SortByName 

Sort ascending by name.

◆ ERoutePathAlgorithm

Path calculation algorithm.

Enumerator
PA_ML 

Path calculation algorithm - Service default - Magic Lane routing algorithm.

PA_ME 

Deprecated alias to PA_ML.

PA_SimplifiedML 

Simplified Magic Lane routing algorithm - Best speed, recommended for low end devices.

PA_ExternalCH 

Path calculation algorithm - External CH routing algorithm.

PA_ML_CH 

Magic Lane CH routing algorithm.

◆ ERoutePathFlavor

Path calculation flavors.

Enumerator
PF_ML 

Service default - Magic Lane routing flavor.

PF_GH 

GraphHopper flavor.

◆ ERouteResultDetails

Routing result details.

Enumerator
RD_Full 

Path and guidance.

RD_TimeDistance 

Path time / distance only.

RD_Path 

Path time / distance and geometry.

◆ ERouteResultType

Route result.

Enumerator
RRT_Path 

Path route result type - navigable route.

RRT_Range 

Route range ( Isochrone ) result type - reachable area within a range of travel costs.

◆ ERouteStatus

Status of routing service.

Enumerator
RS_Uninitialized 

Uninitialized.

RS_Calculating 

Calculating.

RS_WaitingInternetConnection 

Waiting for internet connection.

RS_Ready 

Ready.

RS_Error 

Error.

◆ ERouteTransportMode

Transport mode.

Enumerator
RTM_Car 

Transport mode - car.

RTM_Lorry 

Transport mode - lorry/truck.

RTM_Pedestrian 

Transport mode - on foot.

RTM_Bicycle 

Transport mode - bike.

RTM_Public 

Transport mode - public transport.

◆ ERouteType

Route type.

Enumerator
RT_Fastest 

Route type - fastest.

Fastest route between the given waypoints

The default route type

RT_Shortest 

Route type - shortest.

Shortest route between the given waypoints

RT_Economic 

Route type - economical.

Economical, as fuel consumption, route between the given waypoints

RT_Scenic 

Route type - scenic.

Fastest route, with best scenic view, between the given waypoints

RT_Matrix 

Route type - matrix.

Calculate a time and distance matrix for all waypoints

◆ EShapeForm

The form of the shape.

ELine is a simple line with width defined by TShapeType, ECircleSegment (clock wise or counter clock wise depending on drive side) is a part of a TAnchorType::ECircle EPoint is a maker (e.g. Waypoint place) outside the anchor and not connected by a line. Get the index of the next route instruction on the current route segment.

Enumerator
SF_Line 

Line.

SF_CircleSegment 

Circle segment.

SF_Point 

Point.

◆ EShapeType

The type of the shape.

Use the type to render the shape in different width and color. ERoute should be rendered over EStreet

Enumerator
ST_Route 

Route.

ST_Street 

Street.

◆ ESignpostConnectionInfo

Signpost connection info.

Enumerator
SCI_Invalid 

Invalid.

SCI_Branch 

Branch.

SCI_Towards 

Towards.

SCI_Exit 

Exit.

◆ ESignpostItemType

Signpost item type.

Enumerator
SI_Invalid 

Invalid.

SI_PlaceName 

Place name.

SI_RouteNumber 

Route number.

SI_RouteName 

Route name.

SI_ExitNumber 

Exit number.

SI_ExitName 

Exit name.

SI_Pictogram 

Pictogram.

SI_OtherDestination 

Other destination.

◆ ESignpostPictogramType

Signpost pictogram type.

Enumerator
SP_Invalid 

Invalid.

SP_Airport 

Airport.

SP_BusStation 

Bus station.

SP_FairGround 

Fair ground.

SP_Ferry 

Ferry.

SP_FirstAidPost 

First aid post.

SP_Harbour 

Harbour.

SP_Hospital 

Hospital.

SP_HoteMotel 

Hotel/Motel.

SP_IndustrialArea 

Industrial area.

SP_InformationCentre 

Information Centre.

SP_ParkingFacility 

Parking facility.

SP_PetrolStation 

Petrol / fuel station.

SP_RailwayStation 

Railway station.

SP_RestArea 

Rest area.

SP_Restaurant 

Restaurant.

SP_Toilet 

Toilet.

◆ ESurfaceType

Get surface type.

Enumerator
S_Asphalt 

Asphalt.

S_Paved 

Paved.

S_Unpaved 

Unpaved.

S_Unknown 

Unknown.

Asphalt 
Deprecated
Paved 
Deprecated
Unpaved 
Deprecated
Unknown 
Deprecated

◆ ETrafficAvoidance

Traffic avoidance options.

Enumerator
TA_None 

Disable traffic avoidance.

TA_All 

Avoid all traffic events: congestions and roadblocks.

TA_Roadblocks 

Avoid only roadblock traffic events.

◆ ETrafficEventClass

Traffic events classes.

Enumerator
TrafficEventBase 
TrafficOther 

00 - 001 - info

TrafficLevelOfService 

01 - 100 - congestion

TrafficExpectedLevelOfService 

02 - 101 - attention

TrafficAccidents 

03 - 102 - accident

TrafficIncidents 

04 - 103 - accident

TrafficClosuresAndLaneRestrictions 

05 - 104 - no entry

TrafficCarriagewayRestrictions 

06 - 105 - no entry

TrafficExitRestrictions 

07 - 106

TrafficEntryRestrictions 

08 - 107

TrafficTrafficRestrictions 

09 - 108

TrafficCarpoolInfo 

10 - 001 - info

TrafficRoadworks 

11 - 110

TrafficObstructionHazards 

12 - 111

TrafficDangerousSituations 

13 - 112

TrafficRoadConditions 

14 - 113 - slippery road

TrafficTemperatures 

15 - 114

TrafficPrecipitationAndVisibility 

16 - 115 - mandatory

TrafficWindAndAirQuality 

17 - 116

TrafficActivities 

18 - 117

TrafficSecurityAlerts 

19 - 118

TrafficDelays 

20 - 001 - info

TrafficCancellations 

21 - 120 - restrictions removal

TrafficTravelTimeInfo 

22 - 121 - warning

TrafficDangerousVehicles 

23 - 122

TrafficExceptionalLoadsOrVehicles 

24 - 123

TrafficTrafficEquipmentStatus 

25 - 124

TrafficSizeAndWeightLimits 

26 - 125 - circulation closed

TrafficParkingRestrictions 

27 - 126

TrafficParking 

28 - 127

TrafficReferenceToAudioBroadcast 

29 - 001 - info

TrafficServiceMessages 

30 - 001 - info

TrafficSpecialMessages 

31 - 001 - info

TrafficUserEventsBase 

100 - * - user events above this value

TrafficUserRoadblock 

User-defined roadblock.

◆ ETrafficEventImpactZone

Traffic event shape.

Enumerator
TEIZ_Path 

path as a collection of roads impact zone

TEIZ_Area 

geographic area impact zone

◆ ETrafficEventSeverity

Traffic event severity enum.

Enumerator
TES_Stationary 

Stationary.

TES_Queuing 

Queuing.

TES_SlowTraffic 

Slow traffic.

TES_PossibleDelay 

Possible delay.

TES_Unknown 

Unknown.

TES_Free 

Free traffic.

◆ ETrafficOnlineRestrictions

Restrictions which prevent online service functionality.

Enumerator
Settings 

Service is disabled from settings.

Connection 

No internet connection.

NetworkType 

Restricted by network type.

ProviderData 

Missing provider data.

WorldMapVersion 

Outdated world map version.

DiskSpace 

Not enough disk space to store data.

InitFail 

Failed to initialize.

◆ ETrafficUsage

Traffic usage type.

Define how traffic service will be used

Enumerator
UseNone 

No traffic.

UseOnline 

Online and offline ( default ).

UseOffline 

Offline only.

◆ ETransitType

Type of transit.

Enumerator
TT_Walk 

Walk.

TT_Bus 

Bus.

TT_Underground 

Underground.

TT_Railway 

Railway.

TT_Tram 

Tram.

TT_WaterTransport 

Water transport.

TT_Other 

Other.

TT_SharedBike 

Shared bike.

TT_SharedScooter 

Shared scooter.

TT_SharedCar 

Shared car.

TT_Unknown 

Unknown.

◆ ETurnEvent

Navigation turn events.

Enumerator
T_NA 

Turn type not available.

T_Straight 

Continue straight ahead.

T_Right 

Turn right.

T_Right1 

Turn right.

T_Right2 

Turn right.

T_Left 

Turn left.

T_Left1 

Turn left.

T_Left2 

Turn left.

T_LightLeft 

Turn half left.

T_LightLeft1 

Turn half left.

T_LightLeft2 

Turn half left.

T_LightRight 

Turn half right.

T_LightRight1 

Turn half right.

T_LightRight2 

Turn half right.

T_SharpRight 

Turn sharp right.

T_SharpRight1 

Turn sharp right.

T_SharpRight2 

Turn sharp right.

T_SharpLeft 

Turn sharp left.

T_SharpLeft1 

Turn sharp left.

T_SharpLeft2 

Turn sharp left.

T_RoundaboutExitRight 

Leave the roundabout to the right.

T_Roundabout 

Continue on the roundabout.

T_RoundRight 

Make a U-Turn.

T_RoundLeft 

Make a U-Turn.

T_ExitRight 

Take the exit.

T_ExitRight1 

Take the exit.

T_ExitRight2 

Take the exit.

T_InfoGeneric 

Generic info.

T_DriveOn 

Drive on.

T_ExitNr 

Take exit No. ...

T_ExitLeft 

Take the exit.

T_ExitLeft1 

Take the exit.

T_ExitLeft2 

Take the exit.

T_RoundaboutExitLeft 

Leave the roundabout to the left.

T_IntoRoundabout 

Leave the roundabout at the ... exit.

T_StayOn 

Continue straight ahead.

T_BoatFerry 

Take the ferry.

T_RailFerry 

Take the car transport by train.

T_InfoLane 

Lane info.

T_InfoSign 

Info sign.

T_LeftRight 

Left and then turn right.

T_RightLeft 

Right and then turn left.

T_KeepLeft 

Bear left.

T_KeepRight 

Bear right.

T_Start 

Start waypoint.

T_Intermediate 

Intermediate waypoint.

T_Stop 

Stop waypoint.

◆ GetWaypointsOptions

Get route waypoints options.

Enumerator
GW_Initial 

Initial route calculation waypoints.

GW_RemainingInitial 

Remaining to travel set from the initial calculation waypoints.

GW_Remaining 

Remaining to travel set ( user set + service added set ).

Navigating a route will remove all passed by intermediate waypoints.

Routing service may add additional waypoints to route result, e.g. for follow track and EV routing

◆ ProximityAreaDetails

Proximity geofence area result details.

Enumerator
PAD_Geometry 

the GeofenceProximityArea::area will be filled in result