osrm-backend/include/osrm/osrm.hpp

/*

Copyright (c) 2017, Project OSRM contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

#ifndef OSRM_HPP
#define OSRM_HPP

#include "engine/api/base_result.hpp"
#include "osrm/osrm_fwd.hpp"
#include "osrm/status.hpp"

#include <memory>
#include <string>

namespace osrm
{
namespace json = util::json;
using engine::EngineConfig;
using engine::api::MatchParameters;
using engine::api::NearestParameters;
using engine::api::RouteParameters;
using engine::api::TableParameters;
using engine::api::TileParameters;
using engine::api::TripParameters;

/**
 * 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.
 */
class OSRM final
{
  public:
    /**
     * Constructs an OSRM instance with user-configurable settings.
     *
     * \param config The user-provided OSRM configuration.
     * \see EngineConfig
     */
    explicit OSRM(EngineConfig &config);

    ~OSRM();

    // Moveable but not copyable
    OSRM(OSRM &&) noexcept;
    OSRM &operator=(OSRM &&) noexcept;

    /**
     * Shortest path queries for coordinates.
     *
     * \param parameters route query specific parameters
     * \return Status indicating success for the query or failure
     * \see Status, RouteParameters and json::Object
     */
    Status Route(const RouteParameters &parameters, json::Object &result) const;
    Status Route(const RouteParameters &parameters, engine::api::ResultT &result) const;

    /**
     * Distance tables for coordinates.
     *
     * \param parameters table query specific parameters
     * \return Status indicating success for the query or failure
     * \see Status, TableParameters and json::Object
     */
    Status Table(const TableParameters &parameters, json::Object &result) const;
    Status Table(const TableParameters &parameters, engine::api::ResultT &result) const;

    /**
     * Nearest street segment for coordinate.
     *
     * \param parameters nearest query specific parameters
     * \return Status indicating success for the query or failure
     * \see Status, NearestParameters and json::Object
     */
    Status Nearest(const NearestParameters &parameters, json::Object &result) const;
    Status Nearest(const NearestParameters &parameters, engine::api::ResultT &result) const;

    /**
     * Trip: shortest round trip between coordinates.
     *
     * \param parameters trip query specific parameters
     * \return Status indicating success for the query or failure
     * \see Status, TripParameters and json::Object
     */
    Status Trip(const TripParameters &parameters, json::Object &result) const;
    Status Trip(const TripParameters &parameters, engine::api::ResultT &result) const;

    /**
     * Match: snaps noisy coordinate traces to the road network
     *
     * \param parameters match query specific parameters
     * \return Status indicating success for the query or failure
     * \see Status, MatchParameters and json::Object
     */
    Status Match(const MatchParameters &parameters, json::Object &result) const;
    Status Match(const MatchParameters &parameters, engine::api::ResultT &result) const;

    /**
     * Tile: vector tiles with internal graph representation
     *
     * \param parameters tile query specific parameters
     * \return Status indicating success for the query or failure
     * \see Status, TileParameters and json::Object
     */
    Status Tile(const TileParameters &parameters, std::string &result) const;
    Status Tile(const TileParameters &parameters, engine::api::ResultT &result) const;

  private:
    std::unique_ptr<engine::EngineInterface> engine_;
};
} // namespace osrm

#endif // OSRM_HPP