Libosmium  2.9.0
Fast and flexible C++ library for working with OpenStreetMap data
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
multipolygon_collector.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_AREA_MULTIPOLYGON_COLLECTOR_HPP
2 #define OSMIUM_AREA_MULTIPOLYGON_COLLECTOR_HPP
3 
4 /*
5 
6 This file is part of Osmium (http://osmcode.org/libosmium).
7 
8 Copyright 2013-2016 Jochen Topf <jochen@topf.org> and others (see README).
9 
10 Boost Software License - Version 1.0 - August 17th, 2003
11 
12 Permission is hereby granted, free of charge, to any person or organization
13 obtaining a copy of the software and accompanying documentation covered by
14 this license (the "Software") to use, reproduce, display, distribute,
15 execute, and transmit the Software, and to prepare derivative works of the
16 Software, and to permit third-parties to whom the Software is furnished to
17 do so, all subject to the following:
18 
19 The copyright notices in the Software and this entire statement, including
20 the above license grant, this restriction and the following disclaimer,
21 must be included in all copies of the Software, in whole or in part, and
22 all derivative works of the Software, unless such copies or derivative
23 works are solely in the form of machine-executable object code generated by
24 a source language processor.
25 
26 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
29 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
30 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
31 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
32 DEALINGS IN THE SOFTWARE.
33 
34 */
35 
36 #include <algorithm>
37 #include <cstddef>
38 #include <cstring>
39 #include <vector>
40 
41 #include <osmium/area/stats.hpp>
42 #include <osmium/memory/buffer.hpp>
43 #include <osmium/osm/item_type.hpp>
44 #include <osmium/osm/location.hpp>
45 #include <osmium/osm/node_ref.hpp>
46 #include <osmium/osm/relation.hpp>
47 #include <osmium/osm/tag.hpp>
48 #include <osmium/osm/way.hpp>
50 
51 namespace osmium {
52 
53  namespace relations {
54  class RelationMeta;
55  } // namespace relations
56 
60  namespace area {
61 
73  template <typename TAssembler>
74  class MultipolygonCollector : public osmium::relations::Collector<MultipolygonCollector<TAssembler>, false, true, false> {
75 
77 
78  using assembler_config_type = typename TAssembler::config_type;
80 
82 
84 
85  static constexpr size_t initial_output_buffer_size = 1024 * 1024;
86  static constexpr size_t max_buffer_size_for_flush = 100 * 1024;
87 
89  if (this->callback()) {
90  osmium::memory::Buffer buffer(initial_output_buffer_size);
91  using std::swap;
92  swap(buffer, m_output_buffer);
93  this->callback()(std::move(buffer));
94  }
95  }
96 
98  if (m_output_buffer.committed() > max_buffer_size_for_flush) {
100  }
101  }
102 
103  public:
104 
105  explicit MultipolygonCollector(const assembler_config_type& assembler_config) :
106  collector_type(),
107  m_assembler_config(assembler_config),
108  m_output_buffer(initial_output_buffer_size, osmium::memory::Buffer::auto_grow::yes) {
109  }
110 
111  const osmium::area::area_stats& stats() const noexcept {
112  return m_stats;
113  }
114 
121  bool keep_relation(const osmium::Relation& relation) const {
122  const char* type = relation.tags().get_value_by_key("type");
123 
124  // ignore relations without "type" tag
125  if (!type) {
126  return false;
127  }
128 
129  if ((!std::strcmp(type, "multipolygon")) || (!std::strcmp(type, "boundary"))) {
130  return true;
131  }
132 
133  return false;
134  }
135 
139  bool keep_member(const osmium::relations::RelationMeta& /*relation_meta*/, const osmium::RelationMember& member) const {
140  // We are only interested in members of type way.
141  return member.type() == osmium::item_type::way;
142  }
143 
151  // you need at least 4 nodes to make up a polygon
152  if (way.nodes().size() <= 3) {
153  return;
154  }
155  try {
156  if (!way.nodes().front().location() || !way.nodes().back().location()) {
157  throw osmium::invalid_location("invalid location");
158  }
159  if (way.ends_have_same_location()) {
160  // way is closed and has enough nodes, build simple multipolygon
161  TAssembler assembler(m_assembler_config);
162  assembler(way, m_output_buffer);
163  m_stats += assembler.stats();
165  }
166  } catch (const osmium::invalid_location&) {
167  // XXX ignore
168  }
169  }
170 
171  void complete_relation(osmium::relations::RelationMeta& relation_meta) {
172  const osmium::Relation& relation = this->get_relation(relation_meta);
173  const osmium::memory::Buffer& buffer = this->members_buffer();
174 
175  std::vector<const osmium::Way*> ways;
176  for (const auto& member : relation.members()) {
177  if (member.ref() != 0) {
178  const size_t offset = this->get_offset(member.type(), member.ref());
179  ways.push_back(&buffer.get<const osmium::Way>(offset));
180  }
181  }
182 
183  try {
184  TAssembler assembler(m_assembler_config);
185  assembler(relation, ways, m_output_buffer);
186  m_stats += assembler.stats();
188  } catch (const osmium::invalid_location&) {
189  // XXX ignore
190  }
191  }
192 
193  void flush() {
195  }
196 
198  osmium::memory::Buffer buffer(initial_output_buffer_size, osmium::memory::Buffer::auto_grow::yes);
199 
200  using std::swap;
201  swap(buffer, m_output_buffer);
202 
203  return buffer;
204  }
205 
206  }; // class MultipolygonCollector
207 
208  } // namespace area
209 
210 } // namespace osmium
211 
212 #endif // OSMIUM_AREA_MULTIPOLYGON_COLLECTOR_HPP
WayNodeList & nodes()
Definition: way.hpp:76
osmium::memory::Buffer & members_buffer()
Definition: collector.hpp:493
void possibly_flush_output_buffer()
Definition: multipolygon_collector.hpp:97
osmium::area::area_stats m_stats
Definition: multipolygon_collector.hpp:83
type
Definition: entity_bits.hpp:63
bool keep_member(const osmium::relations::RelationMeta &, const osmium::RelationMember &member) const
Definition: multipolygon_collector.hpp:139
RelationMemberList & members()
Definition: relation.hpp:177
static constexpr size_t initial_output_buffer_size
Definition: multipolygon_collector.hpp:85
Definition: relation.hpp:165
MultipolygonCollector(const assembler_config_type &assembler_config)
Definition: multipolygon_collector.hpp:105
size_t size() const noexcept
Definition: node_ref_list.hpp:69
static constexpr size_t max_buffer_size_for_flush
Definition: multipolygon_collector.hpp:86
Definition: entity_bits.hpp:70
void swap(Buffer &lhs, Buffer &rhs)
Definition: buffer.hpp:731
size_t get_offset(osmium::item_type type, osmium::object_id_type id)
Definition: collector.hpp:497
Definition: way.hpp:66
void way_not_in_any_relation(const osmium::Way &way)
Definition: multipolygon_collector.hpp:150
Definition: relation.hpp:54
void flush()
Definition: multipolygon_collector.hpp:193
Namespace for everything in the Osmium library.
Definition: assembler.hpp:73
Definition: collector.hpp:100
const osmium::Relation & get_relation(size_t offset) const
Definition: collector.hpp:310
Definition: location.hpp:52
const assembler_config_type m_assembler_config
Definition: multipolygon_collector.hpp:79
const osmium::area::area_stats & stats() const noexcept
Definition: multipolygon_collector.hpp:111
bool ends_have_same_location() const
Definition: way.hpp:107
osmium::memory::Buffer read()
Definition: multipolygon_collector.hpp:197
bool keep_relation(const osmium::Relation &relation) const
Definition: multipolygon_collector.hpp:121
Definition: stats.hpp:49
void complete_relation(osmium::relations::RelationMeta &relation_meta)
Definition: multipolygon_collector.hpp:171
const TagList & tags() const
Get the list of tags for this object.
Definition: object.hpp:309
item_type type() const noexcept
Definition: relation.hpp:126
Definition: multipolygon_collector.hpp:74
osmium::Location & location() noexcept
Definition: node_ref.hpp:79
osmium::memory::Buffer m_output_buffer
Definition: multipolygon_collector.hpp:81
size_t committed() const noexcept
Definition: buffer.hpp:241
typename TAssembler::config_type assembler_config_type
Definition: multipolygon_collector.hpp:78
Definition: buffer.hpp:97
T & get(const size_t offset) const
Definition: buffer.hpp:379
const NodeRef & front() const noexcept
Definition: node_ref_list.hpp:93
const NodeRef & back() const noexcept
Definition: node_ref_list.hpp:103
const char * get_value_by_key(const char *key, const char *default_value=nullptr) const noexcept
Definition: tag.hpp:134
void flush_output_buffer()
Definition: multipolygon_collector.hpp:88