Classes and methods for handling routing aspects of object in the libosmscout db. More...

Classes
class	osmscout::AbstractRoutingProfile
	Common base class for our concrete profile instantiations. More...

class	osmscout::AbstractRoutingService< RoutingState >
	Abstract algorithms for routing. More...

struct	osmscout::DBFileOffset
	Helper structure to implement a reference to a routing node in a given db (identified by a unique index). More...

struct	osmscout::DBId
	Helper structure to implement a reference to a routing node in a given db (identified by a unique index). More...

class	osmscout::FastestPathRoutingProfile
	Profile that defines costs base of the time the traveling device needs for a certain way resulting in the fastest path chosen (cost=distance/speedForWayType). More...

class	osmscout::MultiDBRoutingService
	Util class for routing cross databases. More...

class	osmscout::MultiDBRoutingState
	State for MultiDBRoutingService. More...

struct	osmscout::ObjectVariantData
	For every unique combination of object attributes that are routing relevant we store an ObjectvariantData entry. More...

class	osmscout::RouteData

class	osmscout::RouteDescription
	Description of a route, enhanced with information that are required to give a human textual (or narrative) drive instructions;. More...

class	osmscout::RouteDescription::CrossingWaysDescription
	List the names of all ways, that are crossing the current node. More...

class	osmscout::RouteDescription::Description
	Base class of all descriptions. More...

class	osmscout::RouteDescription::DestinationDescription
	Destination of the route. More...

class	osmscout::RouteDescription::DirectionDescription
	Describes the turn and the curve while getting from the previous node to the next node via the current node. More...

class	osmscout::RouteDescription::LaneDescription
	A route lane. More...

class	osmscout::RouteDescription::MaxSpeedDescription
	A motorway junction. More...

class	osmscout::RouteDescription::MotorwayChangeDescription
	Signals changing a motorway. More...

class	osmscout::RouteDescription::MotorwayEnterDescription
	Signals entering a motorway. More...

class	osmscout::RouteDescription::MotorwayJunctionDescription
	A motorway junction. More...

class	osmscout::RouteDescription::MotorwayLeaveDescription
	Signals leaving a motorway. More...

class	osmscout::RouteDescription::NameChangedDescription
	Something has a name. More...

class	osmscout::RouteDescription::NameDescription
	Something has a name. More...

class	osmscout::RouteDescription::Node

class	osmscout::RouteDescription::POIAtRouteDescription
	A motorway junction. More...

class	osmscout::RouteDescription::RoundaboutEnterDescription
	Signals entering a roundabout. More...

class	osmscout::RouteDescription::RoundaboutLeaveDescription
	Signals leaving a roundabout. More...

class	osmscout::RouteDescription::StartDescription
	Start of the route. More...

class	osmscout::RouteDescription::SuggestedLaneDescription
	A suggested route lanes. More...

class	osmscout::RouteDescription::TargetDescription
	Target of the route. More...

class	osmscout::RouteDescription::TurnDescription
	Signals an explicit turn. More...

class	osmscout::RouteDescription::TypeNameDescription
	Something has a type name. More...

class	osmscout::RouteDescription::ViaDescription
	Start of the route. More...

class	osmscout::RouteNode
	A route node is the representation of a node in the routing graph. More...

struct	osmscout::RouteNode::Exclude
	Exclude regarding use of paths. More...

struct	osmscout::RouteNode::ObjectData
	Information for an object referenced by a path. More...

struct	osmscout::RouteNode::Path
	A single path that starts at the given route node. More...

class	osmscout::RouteNodeDataFile

class	osmscout::RoutePosition
	Start or end position of a route calculation. More...

class	osmscout::RoutePostprocessor
	RouteProcessor allows to enhance the raw routing information from the routing algorithm with additional information like way names, turns and similar by traversing the route and its objects. More...

class	osmscout::RoutePostprocessor::CrossingWaysPostprocessor
	Places a crossing ways description as a description of the name of all ways crossing the given node. More...

class	osmscout::RoutePostprocessor::DestinationPostprocessor
	Evaluates destination tags, hinting at the destination of a way. More...

class	osmscout::RoutePostprocessor::DirectionPostprocessor
	Places a turn description for every node. More...

class	osmscout::RoutePostprocessor::DistanceAndTimePostprocessor
	Calculates the overall running distance and time for each node. More...

class	osmscout::RoutePostprocessor::InstructionPostprocessor
	Generates drive instructions. More...

class	osmscout::RoutePostprocessor::LanesPostprocessor
	Evaluate route lanes. More...

class	osmscout::RoutePostprocessor::MaxSpeedPostprocessor
	Collects max speed information. More...

class	osmscout::RoutePostprocessor::MotorwayJunctionPostprocessor
	Adds driving hint based on motorway_junction tags. More...

class	osmscout::RoutePostprocessor::POIsPostprocessor
	Collects POIs the vehicle passes by. More...

class	osmscout::RoutePostprocessor::Postprocessor
	Base class for routing processors. More...

class	osmscout::RoutePostprocessor::SectionsPostprocessor
	Adds section to the route if there is one or more via node. More...

class	osmscout::RoutePostprocessor::StartPostprocessor
	Places the given description at the start node. More...

class	osmscout::RoutePostprocessor::SuggestedLanesPostprocessor
	Evaluate suggested route lanes that may be used. More...

class	osmscout::RoutePostprocessor::TargetPostprocessor
	Places the given description at the target node. More...

class	osmscout::RoutePostprocessor::WayNamePostprocessor
	Places a name description as way description. More...

class	osmscout::RoutePostprocessor::WayTypePostprocessor
	Places a name description as way description. More...

class	osmscout::RouterParameter
	Database instance initialization parameter to influence the behavior of the db instance. More...

class	osmscout::RoutingDatabase
	Encapsulation of the routing relevant data files, similar to Database. More...

class	osmscout::RoutingParameter
	Parameter object for routing calculations. More...

class	osmscout::RoutingProfile
	Abstract interface for a routing profile. More...

class	osmscout::RoutingProgress
	Optional callback object for monitoring routing progress. More...

class	osmscout::RoutingService
	Abstract algorithms for routing. More...

struct	osmscout::RoutingService::RNode
	A path in the routing graph from one node to the next (expressed via the target object) with additional information as required by the A* algorithm. More...

struct	osmscout::RoutingService::VNode
	Minimum required data for a node in the ClosedSet. More...

class	osmscout::ShortestPathRoutingProfile
	Profile that defines costs in a way that the shortest way is chosen (cost==distance). More...

class	osmscout::SimpleRoutingService
	The RoutingService implements functionality in the context of routing. More...

struct	osmscout::SpeedVariant
	Possible route speed variants by its grade. More...

Typedefs
using	osmscout::RoutingDatabaseRef = std::shared_ptr< RoutingDatabase >

using	osmscout::RoutingProgressRef = std::shared_ptr< RoutingProgress >

Enumerations
enum	osmscout::Grade : uint8_t { osmscout::SolidGrade = 1 , osmscout::GravelGrade = 2 , osmscout::UnpavedGrade = 3 , osmscout::MostlySoftGrade = 4 , osmscout::SoftGrade = 5 }
	Enum representation of route grade. More...

enum class	osmscout::RouteEndpoint : uint8_t { osmscout::RouteEndpoint::Start , osmscout::RouteEndpoint::Target , osmscout::RouteEndpoint::Unspecified }
	Which end of a route a position is being resolved for. More...

enum class	osmscout::RoutingError : uint8_t { osmscout::RoutingError::None , osmscout::RoutingError::NoStartNode , osmscout::RoutingError::NoTargetNode , osmscout::RoutingError::NoRouteFound , osmscout::RoutingError::DataFailure , osmscout::RoutingError::Aborted }
	Why a routing calculation did not produce a route. More...

Detailed Description

Classes and methods for handling routing aspects of object in the libosmscout db.

Typedef Documentation

◆ RoutingDatabaseRef

using osmscout::RoutingDatabaseRef = typedef std::shared_ptr<RoutingDatabase>

◆ RoutingProgressRef

using osmscout::RoutingProgressRef = typedef std::shared_ptr<RoutingProgress>

Enumeration Type Documentation

◆ Grade

enum osmscout::Grade : uint8_t

Enum representation of route grade.

Enumerator
SolidGrade
GravelGrade
UnpavedGrade
MostlySoftGrade
SoftGrade

◆ RouteEndpoint

enum class osmscout::RouteEndpoint : uint8_t

strong

Which end of a route a position is being resolved for.

The two ends attach to their way along opposite halves of it: the start searches forward from the attach index, the target searches backward from it (see GetStartForwardRouteNode and GetTargetForwardRouteNode). On a way that is direction-restricted — a one-way street, a slip road — a position can therefore attach as a start and not as a target, which is why a resolution that is allowed to pick the closest routable way has to know the end it resolves for.

Unspecified means the end is not known (a via point, or a caller outside this library): no end-specific restriction is applied, which is the behaviour of the resolutions that predate this parameter.

Enumerator
Start
Target
Unspecified

◆ RoutingError

enum class osmscout::RoutingError : uint8_t

strong

Why a routing calculation did not produce a route.

A route calculation fails for several unrelated reasons, and the caller of this library can neither report nor act on the failure while they all look alike. RoutingResult carries the reason so a caller can tell them apart. The values name the cause, not the remedy:

None: no failure (a result carrying a route, or a result nobody failed).
NoStartNode: the start position was resolved to a way, but that way offers no route node reachable from the position in a direction the profile permits.
NoTargetNode: the same for the target position.
NoRouteFound: the search ran and found no connection (the two positions are not connected in the loaded routing data, or the connection is longer than the profile's cost limit allows).
DataFailure: the routing data could not be read (a route node, area or way failed to load).
Aborted: the calculation was cancelled through its breaker.

Enumerator
None
NoStartNode
NoTargetNode
NoRouteFound
DataFailure
Aborted

Classes

Typedefs

Enumerations