From 8a608eb930a0153df14909ca7dd90eb65dddd23f Mon Sep 17 00:00:00 2001 From: Patrick Niklaus Date: Wed, 8 Apr 2015 18:53:10 +0200 Subject: [PATCH] Add some doc to the extractor --- extractor/extraction_way.hpp | 6 ++++++ extractor/extractor_callbacks.cpp | 10 +++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/extractor/extraction_way.hpp b/extractor/extraction_way.hpp index d47de20b0..d344e3665 100644 --- a/extractor/extraction_way.hpp +++ b/extractor/extraction_way.hpp @@ -34,6 +34,12 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #include #include +/** + * This struct is the direct result of the call to ```way_function``` + * in the lua based profile. + * + * It is split into multiple edge segments in the ExtractorCallback. + */ struct ExtractionWay { ExtractionWay() { clear(); } diff --git a/extractor/extractor_callbacks.cpp b/extractor/extractor_callbacks.cpp index 224468b06..fba9206af 100644 --- a/extractor/extractor_callbacks.cpp +++ b/extractor/extractor_callbacks.cpp @@ -72,7 +72,15 @@ void ExtractorCallbacks::ProcessRestriction( // "y" : "n"); } } -/** warning: caller needs to take care of synchronization! */ +/** + * This function takes the geometry contained in the ```input_way``` and the tags + * computed by the lua profile inside ```parsed_way``` and computes all edge segments. + * + * Depending on the forward/backwards weights the edges are split into forward and backward + * edges. + * + * warning: caller needs to take care of synchronization! + */ void ExtractorCallbacks::ProcessWay(const osmium::Way &input_way, const ExtractionWay &parsed_way) { if (((0 >= parsed_way.forward_speed) ||