e554624438
When using non-default constructors for the API parameter classes, vector arguments like coordinates and hints are copied at least once (twice when passed as lvalue arguments). Enable perfect forwarding of BaseParameter arguments and pass-by-value in the constructor that uses the argument. This ensures we copy at most once (zero for rvalue arguments).
132 lines
4.9 KiB
C++
132 lines
4.9 KiB
C++
/*
|
|
|
|
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 ENGINE_API_BASE_PARAMETERS_HPP
|
|
#define ENGINE_API_BASE_PARAMETERS_HPP
|
|
|
|
#include "engine/approach.hpp"
|
|
#include "engine/bearing.hpp"
|
|
#include "engine/hint.hpp"
|
|
#include "util/coordinate.hpp"
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
#include <algorithm>
|
|
#include <vector>
|
|
|
|
namespace osrm
|
|
{
|
|
namespace engine
|
|
{
|
|
namespace api
|
|
{
|
|
|
|
/**
|
|
* General parameters for OSRM service queries.
|
|
*
|
|
* Holds member attributes:
|
|
* - coordinates: for specifying location(s) to services
|
|
* - hints: hint for the service to derive the position(s) in the road network more efficiently,
|
|
* optional per coordinate
|
|
* - radiuses: limits the search for segments in the road network to given radius(es) in meter,
|
|
* optional per coordinate
|
|
* - bearings: limits the search for segments in the road network to given bearing(s) in degree
|
|
* towards true north in clockwise direction, optional per coordinate
|
|
* - approaches: force the phantom node to start towards the node with the road country side.
|
|
*
|
|
* \see OSRM, Coordinate, Hint, Bearing, RouteParame, RouteParameters, TableParameters,
|
|
* NearestParameters, TripParameters, MatchParameters and TileParameters
|
|
*/
|
|
struct BaseParameters
|
|
{
|
|
|
|
enum class SnappingType
|
|
{
|
|
Default,
|
|
Any
|
|
};
|
|
|
|
enum class OutputFormatType
|
|
{
|
|
JSON,
|
|
FLATBUFFERS
|
|
};
|
|
|
|
std::vector<util::Coordinate> coordinates;
|
|
std::vector<boost::optional<Hint>> hints;
|
|
std::vector<boost::optional<double>> radiuses;
|
|
std::vector<boost::optional<Bearing>> bearings;
|
|
std::vector<boost::optional<Approach>> approaches;
|
|
std::vector<std::string> exclude;
|
|
boost::optional<OutputFormatType> format = OutputFormatType::JSON;
|
|
|
|
// Adds hints to response which can be included in subsequent requests, see `hints` above.
|
|
bool generate_hints = true;
|
|
|
|
// Remove waypoints array from the response.
|
|
bool skip_waypoints = false;
|
|
|
|
SnappingType snapping = SnappingType::Default;
|
|
|
|
BaseParameters(std::vector<util::Coordinate> coordinates_ = {},
|
|
std::vector<boost::optional<Hint>> hints_ = {},
|
|
std::vector<boost::optional<double>> radiuses_ = {},
|
|
std::vector<boost::optional<Bearing>> bearings_ = {},
|
|
std::vector<boost::optional<Approach>> approaches_ = {},
|
|
bool generate_hints_ = true,
|
|
std::vector<std::string> exclude = {},
|
|
const SnappingType snapping_ = SnappingType::Default)
|
|
: coordinates(std::move(coordinates_)), hints(std::move(hints_)),
|
|
radiuses(std::move(radiuses_)), bearings(std::move(bearings_)),
|
|
approaches(std::move(approaches_)), exclude(std::move(exclude)),
|
|
generate_hints(generate_hints_), snapping(snapping_)
|
|
{
|
|
}
|
|
|
|
bool IsValid() const
|
|
{
|
|
return (hints.empty() || hints.size() == coordinates.size()) &&
|
|
(bearings.empty() || bearings.size() == coordinates.size()) &&
|
|
(radiuses.empty() || radiuses.size() == coordinates.size()) &&
|
|
(approaches.empty() || approaches.size() == coordinates.size()) &&
|
|
std::all_of(bearings.begin(),
|
|
bearings.end(),
|
|
[](const boost::optional<Bearing> &bearing_and_range) {
|
|
if (bearing_and_range)
|
|
{
|
|
return bearing_and_range->IsValid();
|
|
}
|
|
return true;
|
|
});
|
|
}
|
|
};
|
|
} // namespace api
|
|
} // namespace engine
|
|
} // namespace osrm
|
|
|
|
#endif // ROUTE_PARAMETERS_HPP
|