+
OSRM
+
Defined in include/osrm/osrm.hpp:63
+
Represents a Open Source Routing Machine with access to its services.
+
This represents an Open Source Routing Machine (OSRM) instance, with the services:
+
+Route: shortest path queries for coordinates
+
+Table: distance tables for coordinates
+
+Nearest: nearest street segment for coordinate
+
+Trip: shortest round trip between coordinates
+
+Match: snaps noisy coordinate traces to the road network
+
+Tile: vector tiles with internal graph representation
+
+
+
All services take service-specific parameters, fill a JSON object, and return a status code.
+
List of all members
+
| Name | Kind | Owner |
|---|
OSRM | function | Declared here |
+OSRM | function | Declared here |
+Route | function | Declared here |
+Route | function | Declared here |
+Table | function | Declared here |
+Table | function | Declared here |
+Nearest | function | Declared here |
+Nearest | function | Declared here |
+Trip | function | Declared here |
+Trip | function | Declared here |
+Match | function | Declared here |
+Match | function | Declared here |
+Tile | function | Declared here |
+Tile | function | Declared here |
+engine_ | variable | Declared here |
Public Methods
+
| Return | Name | Description |
|---|
| OSRM explicit | Constructs an OSRM instance with user-configurable settings. |
+ | OSRM noexcept | Moveable but not copyable. |
+Status | Route const | Shortest path queries for coordinates. |
+Status | Route const | |
+Status | Table const | Distance tables for coordinates. |
+Status | Table const | |
+Status | Nearest const | Nearest street segment for coordinate. |
+Status | Nearest const | |
+Status | Trip const | Trip: shortest round trip between coordinates. |
+Status | Trip const | |
+Status | Match const | Match: snaps noisy coordinate traces to the road network. |
+Status | Match const | |
+Status | Tile const | Tile: vector tiles with internal graph representation. |
+Status | Tile const | |
+
+
OSRM
+
explicit
+
+
+
explicit OSRM(EngineConfig & config)
+
Defined in include/osrm/osrm.hpp:72
+
Constructs an OSRM instance with user-configurable settings.
+
See also: EngineConfig
+
Parameters
+
| Parameter | Type | Description |
|---|
config | [EngineConfig](osrm-engine-EngineConfig.html#engineconfig-1) & | The user-provided OSRM configuration. |
+
+
OSRM
+
noexcept
+
Defined in include/osrm/osrm.hpp:77
+
Moveable but not copyable.
+
+
+
Route
+
const
+
+
+
Status Route(const RouteParameters & parameters, json::Object & result) const
+
Defined in include/osrm/osrm.hpp:87
+
Shortest path queries for coordinates.
+
Returns
+
Status indicating success for the query or failure
+
See also: Status, RouteParameters and json::Object
+
Parameters
+
| Parameter | Type | Description |
|---|
parameters | const [RouteParameters](osrm-engine-api-RouteParameters.html#routeparameters-7) & | route query specific parameters |
+
+
Route
+
const
+
+
+
Status Route(const RouteParameters & parameters, engine::api::ResultT & result) const
+
Defined in include/osrm/osrm.hpp:88
+
+
+
Table
+
const
+
+
+
Status Table(const TableParameters & parameters, json::Object & result) const
+
Defined in include/osrm/osrm.hpp:97
+
Distance tables for coordinates.
+
Returns
+
Status indicating success for the query or failure
+
See also: Status, TableParameters and json::Object
+
Parameters
+
| Parameter | Type | Description |
|---|
parameters | const [TableParameters](osrm-engine-api-TableParameters.html#tableparameters-5) & | table query specific parameters |
+
+
Table
+
const
+
+
+
Status Table(const TableParameters & parameters, engine::api::ResultT & result) const
+
Defined in include/osrm/osrm.hpp:98
+
+
+
Nearest
+
const
+
+
+
Status Nearest(const NearestParameters & parameters, json::Object & result) const
+
Defined in include/osrm/osrm.hpp:107
+
Nearest street segment for coordinate.
+
Returns
+
Status indicating success for the query or failure
+
See also: Status, NearestParameters and json::Object
+
Parameters
+
| Parameter | Type | Description |
|---|
parameters | const [NearestParameters](osrm-engine-api-NearestParameters.html#nearestparameters-1) & | nearest query specific parameters |
+
+
Nearest
+
const
+
+
+
Status Nearest(const NearestParameters & parameters, engine::api::ResultT & result) const
+
Defined in include/osrm/osrm.hpp:108
+
+
+
Trip
+
const
+
+
+
Status Trip(const TripParameters & parameters, json::Object & result) const
+
Defined in include/osrm/osrm.hpp:117
+
Trip: shortest round trip between coordinates.
+
Returns
+
Status indicating success for the query or failure
+
See also: Status, TripParameters and json::Object
+
Parameters
+
| Parameter | Type | Description |
|---|
parameters | const [TripParameters](osrm-engine-api-TripParameters.html#tripparameters-3) & | trip query specific parameters |
+
+
Trip
+
const
+
+
+
Status Trip(const TripParameters & parameters, engine::api::ResultT & result) const
+
Defined in include/osrm/osrm.hpp:118
+
+
+
Match
+
const
+
+
+
Status Match(const MatchParameters & parameters, json::Object & result) const
+
Defined in include/osrm/osrm.hpp:127
+
Match: snaps noisy coordinate traces to the road network.
+
Returns
+
Status indicating success for the query or failure
+
See also: Status, MatchParameters and json::Object
+
Parameters
+
| Parameter | Type | Description |
|---|
parameters | const [MatchParameters](osrm-engine-api-MatchParameters.html#matchparameters-4) & | match query specific parameters |
+
+
Match
+
const
+
+
+
Status Match(const MatchParameters & parameters, engine::api::ResultT & result) const
+
Defined in include/osrm/osrm.hpp:128
+
+
+
Tile
+
const
+
+
+
Status Tile(const TileParameters & parameters, std::string & result) const
+
Defined in include/osrm/osrm.hpp:137
+
Tile: vector tiles with internal graph representation.
+
Returns
+
Status indicating success for the query or failure
+
See also: Status, TileParameters and json::Object
+
Parameters
+
| Parameter | Type | Description |
|---|
parameters | const [TileParameters](osrm-engine-api-TileParameters.html#tileparameters-1) & | tile query specific parameters |
+
+
Tile
+
const
+
+
+
Status Tile(const TileParameters & parameters, engine::api::ResultT & result) const
+
Defined in include/osrm/osrm.hpp:138
+
Private Attributes
+
| Return | Name | Description |
|---|
std::unique_ptr< engine::EngineInterface > | engine_ | |
+
+
engine_
+
+
+
std::unique_ptr< engine::EngineInterface > engine_
+
Defined in include/osrm/osrm.hpp:141
+