Libosmium  2.15.5
Fast and flexible C++ library for working with OpenStreetMap data
relation.hpp
Go to the documentation of this file.
1 #ifndef OSMIUM_OSM_RELATION_HPP
2 #define OSMIUM_OSM_RELATION_HPP
3 
4 /*
5 
6 This file is part of Osmium (https://osmcode.org/libosmium).
7 
8 Copyright 2013-2020 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 <osmium/memory/collection.hpp> // IWYU pragma: keep
37 #include <osmium/memory/item.hpp>
38 #include <osmium/osm/entity.hpp>
39 #include <osmium/osm/item_type.hpp>
40 #include <osmium/osm/object.hpp>
41 #include <osmium/osm/types.hpp>
43 
44 #include <cstdint>
45 #include <cstdlib>
46 #include <iterator>
47 
48 namespace osmium {
49 
50  namespace builder {
51  template <typename TDerived, typename T>
52  class OSMObjectBuilder;
53 
54  class RelationMemberListBuilder;
55  } // namespace builder
56 
57  class RelationMember : public osmium::memory::detail::ItemHelper {
58 
60 
63  uint16_t m_flags;
65 
66  unsigned char* endpos() {
67  return data() + osmium::memory::padded_length(sizeof(RelationMember) + m_role_size);
68  }
69 
70  const unsigned char* endpos() const {
71  return data() + osmium::memory::padded_length(sizeof(RelationMember) + m_role_size);
72  }
73 
74  template <typename TMember>
76 
77  unsigned char* next() {
78  if (full_member()) {
79  return endpos() + reinterpret_cast<osmium::memory::Item*>(endpos())->byte_size();
80  }
81  return endpos();
82  }
83 
84  const unsigned char* next() const {
85  if (full_member()) {
86  return endpos() + reinterpret_cast<const osmium::memory::Item*>(endpos())->byte_size();
87  }
88  return endpos();
89  }
90 
91  void set_role_size(string_size_type size) noexcept {
92  m_role_size = size;
93  }
94 
95  public:
96 
98 
99  explicit RelationMember(const object_id_type ref = 0, const item_type type = item_type(), const bool full = false) noexcept :
100  m_ref(ref),
101  m_type(type),
102  m_flags(full ? 1 : 0) {
103  }
104 
105  RelationMember(const RelationMember&) = delete;
106  RelationMember& operator=(const RelationMember&) = delete;
107 
108  RelationMember(RelationMember&&) = delete;
110 
111  ~RelationMember() noexcept = default;
112 
113  object_id_type ref() const noexcept {
114  return m_ref;
115  }
116 
119  m_ref = ref;
120  return *this;
121  }
122 
124  return static_cast<unsigned_object_id_type>(std::abs(m_ref));
125  }
126 
128  m_ref = ref;
129  return *this;
130  }
131 
132  item_type type() const noexcept {
133  return m_type;
134  }
135 
136  bool full_member() const noexcept {
137  return m_flags == 1;
138  }
139 
140  const char* role() const noexcept {
141  return reinterpret_cast<const char*>(data() + sizeof(RelationMember));
142  }
143 
145  return *reinterpret_cast<OSMObject*>(endpos());
146  }
147 
148  const OSMObject& get_object() const {
149  return *reinterpret_cast<const OSMObject*>(endpos());
150  }
151 
152  }; // class RelationMember
153 
154  class RelationMemberList : public osmium::memory::Collection<RelationMember, osmium::item_type::relation_member_list> {
155 
156  public:
157 
158  constexpr static bool is_compatible_to(osmium::item_type t) noexcept {
161  }
162 
163  RelationMemberList() noexcept = default;
164 
165  }; // class RelationMemberList
166 
167 
168  class Relation : public OSMObject {
169 
170  template <typename TDerived, typename T>
172 
173  Relation() noexcept :
174  OSMObject(sizeof(Relation), osmium::item_type::relation) {
175  }
176 
177  public:
178 
180 
181  constexpr static bool is_compatible_to(osmium::item_type t) noexcept {
182  return t == itemtype;
183  }
184 
187  return osmium::detail::subitem_of_type<RelationMemberList>(begin(), end());
188  }
189 
191  const RelationMemberList& members() const {
192  return osmium::detail::subitem_of_type<const RelationMemberList>(cbegin(), cend());
193  }
194 
196  const RelationMemberList& cmembers() const {
197  return osmium::detail::subitem_of_type<const RelationMemberList>(cbegin(), cend());
198  }
199 
200  }; // class Relation
201 
202 
203 } // namespace osmium
204 
205 #endif // OSMIUM_OSM_RELATION_HPP
osmium::builder::OSMObjectBuilder
Definition: osm_object_builder.hpp:402
osmium::OSMObject
Definition: object.hpp:64
item.hpp
OSMIUM_DEPRECATED
#define OSMIUM_DEPRECATED
Definition: compatibility.hpp:51
osmium::Relation::cmembers
const RelationMemberList & cmembers() const
Get a const reference to the member list.
Definition: relation.hpp:196
types.hpp
osmium::object_id_type
int64_t object_id_type
Type for OSM object (node, way, or relation) IDs.
Definition: types.hpp:45
osmium::RelationMember::type
item_type type() const noexcept
Definition: relation.hpp:132
osmium::RelationMember::get_object
const OSMObject & get_object() const
Definition: relation.hpp:148
osmium::RelationMember::role
const char * role() const noexcept
Definition: relation.hpp:140
osmium::RelationMember::operator=
RelationMember & operator=(const RelationMember &)=delete
osmium::RelationMember::endpos
const unsigned char * endpos() const
Definition: relation.hpp:70
osmium::RelationMember::collection_type
static constexpr item_type collection_type
Definition: relation.hpp:97
osmium::RelationMember::m_flags
uint16_t m_flags
Definition: relation.hpp:63
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::itemtype
static constexpr osmium::item_type itemtype
Definition: collection.hpp:128
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::item_type::relation_member_list
@ relation_member_list
osmium::RelationMemberList::is_compatible_to
constexpr static bool is_compatible_to(osmium::item_type t) noexcept
Definition: relation.hpp:158
osmium::memory::CollectionIterator
Definition: collection.hpp:47
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::cbegin
const_iterator cbegin() const noexcept
Definition: collection.hpp:164
osmium::item_type::relation_member_list_with_full_members
@ relation_member_list_with_full_members
osmium::RelationMember::full_member
bool full_member() const noexcept
Definition: relation.hpp:136
osmium::RelationMember::m_type
item_type m_type
Definition: relation.hpp:62
osmium::RelationMember::next
unsigned char * next()
Definition: relation.hpp:77
compatibility.hpp
osmium
Namespace for everything in the Osmium library.
Definition: assembler.hpp:53
osmium::memory::Item
Definition: item.hpp:105
osmium::Relation::is_compatible_to
constexpr static bool is_compatible_to(osmium::item_type t) noexcept
Definition: relation.hpp:181
osmium::RelationMember::next
const unsigned char * next() const
Definition: relation.hpp:84
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::cend
const_iterator cend() const noexcept
Definition: collection.hpp:168
osmium::RelationMember::~RelationMember
~RelationMember() noexcept=default
osmium::RelationMember::set_ref
RelationMember & set_ref(const osmium::object_id_type ref) noexcept
Definition: relation.hpp:127
collection.hpp
entity.hpp
osmium::Relation
Definition: relation.hpp:168
osmium::builder::RelationMemberListBuilder
Definition: osm_object_builder.hpp:229
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::end
iterator end() noexcept
Definition: collection.hpp:160
osmium::RelationMember
Definition: relation.hpp:57
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::begin
iterator begin() noexcept
Definition: collection.hpp:156
osmium::RelationMember::set_role_size
void set_role_size(string_size_type size) noexcept
Definition: relation.hpp:91
osmium::RelationMember::ref
OSMIUM_DEPRECATED RelationMember & ref(object_id_type ref) noexcept
Definition: relation.hpp:118
osmium::Relation::Relation
Relation() noexcept
Definition: relation.hpp:173
osmium::RelationMember::ref
object_id_type ref() const noexcept
Definition: relation.hpp:113
osmium::Relation::members
const RelationMemberList & members() const
Get a const reference to the member list.
Definition: relation.hpp:191
osmium::memory::padded_length
constexpr std::size_t padded_length(std::size_t length) noexcept
Definition: item.hpp:64
osmium::RelationMember::endpos
unsigned char * endpos()
Definition: relation.hpp:66
osmium::Relation::members
RelationMemberList & members()
Get a reference to the member list.
Definition: relation.hpp:186
osmium::item_type::relation
@ relation
object.hpp
item_type.hpp
osmium::RelationMember::get_object
OSMObject & get_object()
Definition: relation.hpp:144
osmium::RelationMemberList
Definition: relation.hpp:154
osmium::memory::Collection
Definition: collection.hpp:117
osmium::memory::CollectionIterator::data
unsigned char * data() const noexcept
Definition: collection.hpp:91
osmium::RelationMember::RelationMember
RelationMember(const object_id_type ref=0, const item_type type=item_type(), const bool full=false) noexcept
Definition: relation.hpp:99
osmium::string_size_type
uint16_t string_size_type
Definition: types.hpp:59
osmium::item_type
item_type
Definition: item_type.hpp:43
osmium::RelationMemberList::RelationMemberList
RelationMemberList() noexcept=default
osmium::RelationMember::positive_ref
unsigned_object_id_type positive_ref() const noexcept
Definition: relation.hpp:123
osmium::RelationMember::m_ref
object_id_type m_ref
Definition: relation.hpp:61
osmium::RelationMember::m_role_size
string_size_type m_role_size
Definition: relation.hpp:64