Libosmium  2.1.0
Fast and flexible C++ library for working with OpenStreetMap data
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
osm_object_builder.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_BUILDER_OSM_OBJECT_BUILDER_HPP
2 #define OSMIUM_BUILDER_OSM_OBJECT_BUILDER_HPP
3 
4 /*
5 
6 This file is part of Osmium (http://osmcode.org/libosmium).
7 
8 Copyright 2013-2015 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 <cstring>
37 #include <initializer_list>
38 #include <new>
39 #include <string>
40 #include <utility>
41 
43 #include <osmium/osm.hpp>
44 #include <osmium/osm/item_type.hpp>
45 #include <osmium/osm/location.hpp>
46 #include <osmium/osm/node_ref.hpp>
47 #include <osmium/osm/object.hpp>
48 #include <osmium/osm/tag.hpp>
49 #include <osmium/osm/types.hpp>
50 #include <osmium/util/cast.hpp>
51 
52 namespace osmium {
53 
54  namespace memory {
55  class Buffer;
56  }
57 
58  namespace builder {
59 
60  class TagListBuilder : public ObjectBuilder<TagList> {
61 
62  public:
63 
64  explicit TagListBuilder(osmium::memory::Buffer& buffer, Builder* parent=nullptr) :
65  ObjectBuilder<TagList>(buffer, parent) {
66  }
67 
69  add_padding();
70  }
71 
78  void add_tag(const char* key, const char* value) {
79  add_size(append(key) + append(value));
80  }
81 
88  void add_tag(const std::string& key, const std::string& value) {
89  add_size(append(key.data(), static_cast_with_assert<string_size_type>(key.size() + 1)) +
90  append(value.data(), static_cast_with_assert<string_size_type>(value.size() + 1)));
91  }
92 
93  }; // class TagListBuilder
94 
95  template <class T>
96  class NodeRefListBuilder : public ObjectBuilder<T> {
97 
98  public:
99 
101  ObjectBuilder<T>(buffer, parent) {
102  }
103 
105  static_cast<Builder*>(this)->add_padding();
106  }
107 
108  void add_node_ref(const NodeRef& node_ref) {
109  new (static_cast<Builder*>(this)->reserve_space_for<osmium::NodeRef>()) osmium::NodeRef(node_ref);
110  static_cast<Builder*>(this)->add_size(sizeof(osmium::NodeRef));
111  }
112 
113  void add_node_ref(const object_id_type ref, const osmium::Location location=Location()) {
114  add_node_ref(NodeRef(ref, location));
115  }
116 
117  }; // class NodeRefListBuilder
118 
122 
123  class RelationMemberListBuilder : public ObjectBuilder<RelationMemberList> {
124 
133  void add_role(osmium::RelationMember& member, const char* role, const string_size_type length) {
134  member.set_role_size(length);
135  add_size(append(role, length));
136  add_padding(true);
137  }
138 
146  void add_role(osmium::RelationMember& member, const char* role) {
147  add_role(member, role, static_cast_with_assert<string_size_type>(std::strlen(role) + 1));
148  }
149 
157  void add_role(osmium::RelationMember& member, const std::string& role) {
158  add_role(member, role.data(), static_cast_with_assert<string_size_type>(role.size() + 1));
159  }
160 
161  public:
162 
164  ObjectBuilder<RelationMemberList>(buffer, parent) {
165  }
166 
168  add_padding();
169  }
170 
181  void add_member(osmium::item_type type, object_id_type ref, const char* role, const osmium::OSMObject* full_member = nullptr) {
182  osmium::RelationMember* member = reserve_space_for<osmium::RelationMember>();
183  new (member) osmium::RelationMember(ref, type, full_member != nullptr);
184  add_size(sizeof(RelationMember));
185  add_role(*member, role);
186  if (full_member) {
187  add_item(full_member);
188  }
189  }
190 
201  void add_member(osmium::item_type type, object_id_type ref, const std::string& role, const osmium::OSMObject* full_member = nullptr) {
202  osmium::RelationMember* member = reserve_space_for<osmium::RelationMember>();
203  new (member) osmium::RelationMember(ref, type, full_member != nullptr);
204  add_size(sizeof(RelationMember));
205  add_role(*member, role);
206  if (full_member) {
207  add_item(full_member);
208  }
209  }
210 
211  }; // class RelationMemberListBuilder
212 
213  template <class T>
214  class OSMObjectBuilder : public ObjectBuilder<T> {
215 
216  public:
217 
219  ObjectBuilder<T>(buffer, parent) {
220  static_cast<Builder*>(this)->reserve_space_for<string_size_type>();
221  static_cast<Builder*>(this)->add_size(sizeof(string_size_type));
222  }
223 
224  void add_tags(const std::initializer_list<std::pair<const char*, const char*>>& tags) {
225  osmium::builder::TagListBuilder tl_builder(static_cast<Builder*>(this)->buffer(), this);
226  for (const auto& p : tags) {
227  tl_builder.add_tag(p.first, p.second);
228  }
229  }
230 
231  }; // class OSMObjectBuilder
232 
235 
236  class WayBuilder : public OSMObjectBuilder<osmium::Way> {
237 
238  public:
239 
240  explicit WayBuilder(osmium::memory::Buffer& buffer, Builder* parent=nullptr) :
241  OSMObjectBuilder<osmium::Way>(buffer, parent) {
242  }
243 
244  void add_node_refs(const std::initializer_list<osmium::NodeRef>& nodes) {
246  for (const auto& node_ref : nodes) {
247  builder.add_node_ref(node_ref);
248  }
249  }
250 
251  }; // class WayBuilder
252 
253  class AreaBuilder : public OSMObjectBuilder<osmium::Area> {
254 
255  public:
256 
257  explicit AreaBuilder(osmium::memory::Buffer& buffer, Builder* parent=nullptr) :
258  OSMObjectBuilder<osmium::Area>(buffer, parent) {
259  }
260 
265  osmium::Area& area = object();
266  area.set_id(osmium::object_id_to_area_id(source.id(), source.type()));
267  area.set_version(source.version());
268  area.set_changeset(source.changeset());
269  area.set_timestamp(source.timestamp());
270  area.set_visible(source.visible());
271  area.set_uid(source.uid());
272 
273  add_user(source.user());
274  }
275 
276  }; // class AreaBuilder
277 
279 
280  } // namespace builder
281 
282 } // namespace osmium
283 
284 #endif // OSMIUM_BUILDER_OSM_OBJECT_BUILDER_HPP
Definition: osm_object_builder.hpp:214
NodeRefListBuilder< InnerRing > InnerRingBuilder
Definition: osm_object_builder.hpp:121
~TagListBuilder()
Definition: osm_object_builder.hpp:68
osmium::memory::Buffer & buffer() noexcept
Return the buffer this builder is using.
Definition: builder.hpp:165
Definition: tag.hpp:105
type
Definition: entity_bits.hpp:60
WayBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:240
AreaBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:257
void add_member(osmium::item_type type, object_id_type ref, const char *role, const osmium::OSMObject *full_member=nullptr)
Definition: osm_object_builder.hpp:181
void initialize_from_object(const osmium::OSMObject &source)
Definition: osm_object_builder.hpp:264
void add_user(const char *user, const string_size_type length)
Definition: builder.hpp:192
OSMObjectBuilder< osmium::Node > NodeBuilder
Definition: osm_object_builder.hpp:233
item_type
Definition: item_type.hpp:42
~RelationMemberListBuilder()
Definition: osm_object_builder.hpp:167
Definition: area.hpp:113
Definition: relation.hpp:145
OSMObject & set_id(object_id_type id) noexcept
Definition: object.hpp:123
Definition: way.hpp:65
RelationMemberListBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:163
osmium::object_id_type object_id_to_area_id(osmium::object_id_type id, osmium::item_type type) noexcept
Definition: area.hpp:92
NodeRefListBuilder< WayNodeList > WayNodeListBuilder
Definition: osm_object_builder.hpp:119
void add_role(osmium::RelationMember &member, const char *role)
Definition: osm_object_builder.hpp:146
Definition: osm_object_builder.hpp:96
Definition: relation.hpp:54
int64_t object_id_type
Type for OSM object (node, way, or relation) IDs.
Definition: types.hpp:46
Namespace for everything in the Osmium library.
Definition: assembler.hpp:55
void add_tags(const std::initializer_list< std::pair< const char *, const char * >> &tags)
Definition: osm_object_builder.hpp:224
void add_node_refs(const std::initializer_list< osmium::NodeRef > &nodes)
Definition: osm_object_builder.hpp:244
void add_role(osmium::RelationMember &member, const char *role, const string_size_type length)
Definition: osm_object_builder.hpp:133
OSMObjectBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:218
uint16_t string_size_type
Definition: types.hpp:59
NodeRefListBuilder< OuterRing > OuterRingBuilder
Definition: osm_object_builder.hpp:120
OSMObject & set_timestamp(const osmium::Timestamp timestamp) noexcept
Definition: object.hpp:283
void add_node_ref(const object_id_type ref, const osmium::Location location=Location())
Definition: osm_object_builder.hpp:113
user_id_type uid() const noexcept
Get user id of this object.
Definition: object.hpp:233
changeset_id_type changeset() const noexcept
Get changeset id of this object.
Definition: object.hpp:209
OSMObject & set_changeset(changeset_id_type changeset) noexcept
Definition: object.hpp:218
Definition: location.hpp:79
Definition: osm_object_builder.hpp:236
object_id_type id() const noexcept
Get ID of this object.
Definition: object.hpp:109
OSMObject & set_version(object_version_type version) noexcept
Definition: object.hpp:194
object_version_type version() const noexcept
Get version of this object.
Definition: object.hpp:185
void set_role_size(string_size_type size) noexcept
Definition: relation.hpp:96
void add_member(osmium::item_type type, object_id_type ref, const std::string &role, const osmium::OSMObject *full_member=nullptr)
Definition: osm_object_builder.hpp:201
NodeRefListBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:100
Definition: buffer.hpp:95
Definition: builder.hpp:172
OSMObject & set_visible(bool visible) noexcept
Definition: object.hpp:162
~NodeRefListBuilder()
Definition: osm_object_builder.hpp:104
osmium::memory::item_size_type append(const char *data, const osmium::memory::item_size_type length)
Definition: builder.hpp:151
ObjectBuilder< osmium::Changeset > ChangesetBuilder
Definition: osm_object_builder.hpp:278
bool visible() const noexcept
Is this object marked visible (ie not deleted)?
Definition: object.hpp:143
void add_role(osmium::RelationMember &member, const std::string &role)
Definition: osm_object_builder.hpp:157
void add_size(uint32_t size)
Definition: builder.hpp:116
void add_item(const osmium::memory::Item *item)
Definition: builder.hpp:127
OSMObjectBuilder< osmium::Relation > RelationBuilder
Definition: osm_object_builder.hpp:234
void add_tag(const std::string &key, const std::string &value)
Definition: osm_object_builder.hpp:88
Definition: node_ref.hpp:50
osmium::Area & object() noexcept
Definition: builder.hpp:182
const char * user() const noexcept
Get user name for this object.
Definition: object.hpp:289
item_type type() const noexcept
Definition: item.hpp:156
osmium::Timestamp timestamp() const noexcept
Get timestamp when this object last changed.
Definition: object.hpp:273
OSMObject & set_uid(user_id_type uid) noexcept
Definition: object.hpp:242
Definition: builder.hpp:57
Definition: osm_object_builder.hpp:123
TagListBuilder(osmium::memory::Buffer &buffer, Builder *parent=nullptr)
Definition: osm_object_builder.hpp:64
void add_tag(const char *key, const char *value)
Definition: osm_object_builder.hpp:78
Definition: object.hpp:57
Definition: osm_object_builder.hpp:60
void add_node_ref(const NodeRef &node_ref)
Definition: osm_object_builder.hpp:108
Definition: osm_object_builder.hpp:253
void add_padding(bool self=false)
Definition: builder.hpp:103