gem.routesAndNavigation. Route

new Route()

Route class

Source

Methods

getElevationSamples(nrOfSamples, beginMeter, endMeter) → {vector.<int>}

Get elevation samples list

Parameters:
NameTypeDescription
nrOfSamplesnumber

Number of samples

beginMeternumber

Begin distance on route for sample interval

endMeternumber

End distance on route for sample interval

Source
Returns:
  • return Elevation samples
Type: 
vector.<int>

getNavigationInstructionSection(nId) → {gem.routesAndNavigation.RouteInstructionList}

Get the list of navigation instruction for specified route section

Parameters:
NameTypeDescription
nIdnumber

id for the route section

Source
Returns:
  • routeInstructionList
Type: 
gem.routesAndNavigation.RouteInstructionList

getNavigationInstructionSectionsSize() → {number}

Get route sections size

Source
Returns:
  • number of route sections
Type: 
number

getTerrainRoadTypeSection() → {vector.<gem.routesAndNavigation.RoadTypeSection>}

Get list of route sections which are of type road, typically, paved.

Source
Returns:
Type: 
vector.<gem.routesAndNavigation.RoadTypeSection>

getTerrainSteepeSections(profileVector) → {vector.<gem.routesAndNavigation.SteepSection>}

Get list of route sections which are abrupt, that is, they have a significant elevation change.

Parameters:
NameTypeDescription
profileVectorvector.<float>

categs The user list of steep categories. Each entry contains the max slope for the steep category as diffX / diffY.

Source
Returns:
  • A positive value is for an ascension category, a negative value if a descent category
Type: 
vector.<gem.routesAndNavigation.SteepSection>

getTerrainSurfaceTypeSection() → {vector.<gem.routesAndNavigation.SurfaceSection>}

Get list of route sections which are flat, that is, no significant elevation change.

Source
Returns:
Type: 
vector.<gem.routesAndNavigation.SurfaceSection>

getTotalDistanceMAndTimeS() → {gem.core.TimeAndDistance}

Get length in meters and estimated travel time in seconds for the route

Source
Returns:
Type: 
gem.core.TimeAndDistance

getTrafficEvents() → {gem.routesAndNavigation.RouteTrafficEventList}

Get list of traffic events affecting the route.

Source
Returns:
  • list of traffic events along the route
Type: 
gem.routesAndNavigation.RouteTrafficEventList