Libosmium: include/osmium/handler/node_locations_for_ways.hpp Source File

Libosmium Fast and flexible C++ library for working with OpenStreetMap data

Loading...
Searching...
No Matches
node_locations_for_ways.hpp
Go to the documentation of this file.
1#ifndef OSMIUM_HANDLER_NODE_LOCATIONS_FOR_WAYS_HPP
2#define OSMIUM_HANDLER_NODE_LOCATIONS_FOR_WAYS_HPP
3
4/*
5
6This file is part of Osmium (https://osmcode.org/libosmium).
7
8Copyright 2013-2026 Jochen Topf <jochen@topf.org> and others (see README).
9
10Boost Software License - Version 1.0 - August 17th, 2003
11
12Permission is hereby granted, free of charge, to any person or organization
13obtaining a copy of the software and accompanying documentation covered by
14this license (the "Software") to use, reproduce, display, distribute,
15execute, and transmit the Software, and to prepare derivative works of the
16Software, and to permit third-parties to whom the Software is furnished to
17do so, all subject to the following:
18
19The copyright notices in the Software and this entire statement, including
20the above license grant, this restriction and the following disclaimer,
21must be included in all copies of the Software, in whole or in part, and
22all derivative works of the Software, unless such copies or derivative
23works are solely in the form of machine-executable object code generated by
24a source language processor.
25
26THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
29SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
30FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
31ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
32DEALINGS IN THE SOFTWARE.
33
34*/
35
36#include <osmium/handler.hpp>
37#include <osmium/index/index.hpp>
38#include <osmium/index/map/dummy.hpp>
39#include <osmium/index/node_locations_map.hpp>
40#include <osmium/osm/location.hpp>
41#include <osmium/osm/node.hpp>
42#include <osmium/osm/node_ref.hpp>
43#include <osmium/osm/types.hpp>
44#include <osmium/osm/way.hpp>
45
46#include <limits>
47#include <type_traits>
48
49namespace osmium {
50
51 namespace handler {
52
53 using dummy_type = osmium::index::map::Dummy<osmium::unsigned_object_id_type, osmium::Location>;
54
63 template <typename TStoragePosIDs, typename TStorageNegIDs = dummy_type>
64 class NodeLocationsForWays : public osmium::handler::Handler {
65
66 template <typename T>
67 using based_on_map = std::is_base_of<osmium::index::map::Map<osmium::unsigned_object_id_type, osmium::Location>, T>;
68
69
70 public:
71
72 using index_pos_type = TStoragePosIDs;
73 using index_neg_type = TStorageNegIDs;
74
75 private:
76
78 TStoragePosIDs& m_storage_pos;
79
81 TStorageNegIDs& m_storage_neg;
82
83 osmium::unsigned_object_id_type m_last_id = 0;
84
85 bool m_ignore_errors = false;
86
87 bool m_must_sort = false;
88
89 // It is okay to have this static dummy instance, even when using several threads,
90 // because it is read-only.
91 static dummy_type& get_dummy() {
92 static dummy_type instance;
93 return instance;
94 }
95
96 public:
97
98 explicit NodeLocationsForWays(TStoragePosIDs& storage_pos,
99 TStorageNegIDs& storage_neg = get_dummy()) noexcept :
100 m_storage_pos(storage_pos),
101 m_storage_neg(storage_neg) {
102 }
103
104 NodeLocationsForWays(const NodeLocationsForWays&) = delete;
105 NodeLocationsForWays& operator=(const NodeLocationsForWays&) = delete;
106
107 NodeLocationsForWays(NodeLocationsForWays&&) noexcept = default;
108 NodeLocationsForWays& operator=(NodeLocationsForWays&&) noexcept = default;
109
110 ~NodeLocationsForWays() noexcept = default;
111
112 void ignore_errors() {
113 m_ignore_errors = true;
114 }
115
116 TStoragePosIDs& storage_pos() noexcept {
117 return m_storage_pos;
118 }
119
120 TStorageNegIDs& storage_neg() noexcept {
121 return m_storage_neg;
122 }
123
127 void node(const osmium::Node& node) {
128 if (node.positive_id() < m_last_id) {
129 m_must_sort = true;
130 }
131 m_last_id = node.positive_id();
132
133 const auto id = node.id();
134 if (id >= 0) {
135 m_storage_pos.set(static_cast<osmium::unsigned_object_id_type>( id), node.location());
136 } else {
137 m_storage_neg.set(static_cast<osmium::unsigned_object_id_type>(-id), node.location());
138 }
139 }
140
144 osmium::Location get_node_location(const osmium::object_id_type id) const {
145 if (id >= 0) {
146 return m_storage_pos.get_noexcept(static_cast<osmium::unsigned_object_id_type>(id));
147 }
148 return m_storage_neg.get_noexcept(static_cast<osmium::unsigned_object_id_type>(-id));
149 }
150
155 void way(osmium::Way& way) {
156 if (m_must_sort) {
157 m_storage_pos.sort();
158 m_storage_neg.sort();
159 m_must_sort = false;
160 m_last_id = std::numeric_limits<osmium::unsigned_object_id_type>::max();
161 }
162 bool error = false;
163 for (auto& node_ref : way.nodes()) {
164 node_ref.set_location(get_node_location(node_ref.ref()));
165 if (!node_ref.location()) {
166 error = true;
167 }
168 }
169 if (!m_ignore_errors && error) {
170 throw osmium::not_found{"location for one or more nodes not found in node location index"};
171 }
172 }
173
179 void clear() {
180 m_storage_pos.clear();
181 m_storage_neg.clear();
182 }
183
184 }; // class NodeLocationsForWays
185
186 } // namespace handler
187
188} // namespace osmium
189
190#endif // OSMIUM_HANDLER_NODE_LOCATIONS_FOR_WAYS_HPP
osmium::Location
Definition location.hpp:279
osmium::Node
Definition node.hpp:48
osmium::Way
Definition way.hpp:72
osmium::handler::Handler
Definition handler.hpp:71
osmium::handler::NodeLocationsForWays::storage_pos
TStoragePosIDs & storage_pos() noexcept
Definition node_locations_for_ways.hpp:116
osmium::handler::NodeLocationsForWays::based_on_map
std::is_base_of< osmium::index::map::Map< osmium::unsigned_object_id_type, osmium::Location >, T > based_on_map
Definition node_locations_for_ways.hpp:67
osmium::handler::NodeLocationsForWays::way
void way(osmium::Way &way)
Definition node_locations_for_ways.hpp:155
osmium::handler::NodeLocationsForWays::m_last_id
osmium::unsigned_object_id_type m_last_id
Definition node_locations_for_ways.hpp:83
osmium::handler::NodeLocationsForWays::NodeLocationsForWays
NodeLocationsForWays(TStoragePosIDs &storage_pos, TStorageNegIDs &storage_neg=get_dummy()) noexcept
Definition node_locations_for_ways.hpp:98
osmium::handler::NodeLocationsForWays::get_node_location
osmium::Location get_node_location(const osmium::object_id_type id) const
Definition node_locations_for_ways.hpp:144
osmium::handler::NodeLocationsForWays::m_storage_pos
TStoragePosIDs & m_storage_pos
Object that handles the actual storage of the node locations (with positive IDs).
Definition node_locations_for_ways.hpp:78
osmium::handler::NodeLocationsForWays::m_ignore_errors
bool m_ignore_errors
Definition node_locations_for_ways.hpp:85
osmium::handler::NodeLocationsForWays::storage_neg
TStorageNegIDs & storage_neg() noexcept
Definition node_locations_for_ways.hpp:120
osmium::handler::NodeLocationsForWays::index_neg_type
TStorageNegIDs index_neg_type
Definition node_locations_for_ways.hpp:73
osmium::handler::NodeLocationsForWays::node
void node(const osmium::Node &node)
Definition node_locations_for_ways.hpp:127
osmium::handler::NodeLocationsForWays::get_dummy
static dummy_type & get_dummy()
Definition node_locations_for_ways.hpp:91
osmium::handler::NodeLocationsForWays::NodeLocationsForWays
NodeLocationsForWays(const NodeLocationsForWays &)=delete
osmium::handler::NodeLocationsForWays::operator=
NodeLocationsForWays & operator=(const NodeLocationsForWays &)=delete
osmium::handler::NodeLocationsForWays::ignore_errors
void ignore_errors()
Definition node_locations_for_ways.hpp:112
osmium::handler::NodeLocationsForWays::m_storage_neg
TStorageNegIDs & m_storage_neg
Object that handles the actual storage of the node locations (with negative IDs).
Definition node_locations_for_ways.hpp:81
osmium::handler::NodeLocationsForWays::clear
void clear()
Definition node_locations_for_ways.hpp:179
osmium::handler::NodeLocationsForWays::index_pos_type
TStoragePosIDs index_pos_type
Definition node_locations_for_ways.hpp:72
osmium::handler::NodeLocationsForWays::m_must_sort
bool m_must_sort
Definition node_locations_for_ways.hpp:87
osmium::handler::NodeLocationsForWays::NodeLocationsForWays
NodeLocationsForWays(NodeLocationsForWays &&) noexcept=default
osmium::index::map::Dummy
Definition dummy.hpp:53
dummy.hpp
handler.hpp
index.hpp
location.hpp
osmium::handler
Osmium handlers provide callbacks for OSM objects.
Definition dynamic_handler.hpp:49
osmium::handler::dummy_type
osmium::index::map::Dummy< osmium::unsigned_object_id_type, osmium::Location > dummy_type
Definition node_locations_for_ways.hpp:53
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
osmium::unsigned_object_id_type
uint64_t unsigned_object_id_type
Type for OSM object (node, way, or relation) IDs where we only allow positive IDs.
Definition types.hpp:46
osmium::object_id_type
int64_t object_id_type
Type for OSM object (node, way, or relation) IDs.
Definition types.hpp:45
node.hpp
node_locations_map.hpp
node_ref.hpp
osmium::not_found
Definition index.hpp:50
types.hpp
way.hpp