Loading...
Searching...
No Matches
relation.hpp
Go to the documentation of this file.
#ifndef OSMIUM_OSM_RELATION_HPP
#define OSMIUM_OSM_RELATION_HPP
/*
This file is part of Osmium (https://osmcode.org/libosmium).
Copyright 2013-2025 Jochen Topf <jochen@topf.org> and others (see README).
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#include <osmium/memory/collection.hpp> // IWYU pragma: keep
#include <osmium/memory/item.hpp>
#include <osmium/osm/entity.hpp>
#include <osmium/osm/item_type.hpp>
#include <osmium/osm/object.hpp>
#include <osmium/osm/types.hpp>
#include <cstdint>
#include <cstdlib>
#include <iterator>
namespace osmium {
namespace builder {
template <typename TDerived, typename T>
class OSMObjectBuilder;
class RelationMemberListBuilder;
} // namespace builder
class RelationMember : public osmium::memory::detail::ItemHelper {
friend class osmium::builder::RelationMemberListBuilder;
object_id_type m_ref;
item_type m_type;
uint16_t m_flags;
string_size_type m_role_size = 0;
unsigned char* endpos() {
return data() + osmium::memory::padded_length(sizeof(RelationMember) + m_role_size);
}
const unsigned char* endpos() const {
return data() + osmium::memory::padded_length(sizeof(RelationMember) + m_role_size);
}
template <typename TMember>
friend class osmium::memory::CollectionIterator;
unsigned char* next() {
if (full_member()) {
return endpos() + reinterpret_cast<osmium::memory::Item*>(endpos())->byte_size();
}
return endpos();
}
const unsigned char* next() const {
if (full_member()) {
return endpos() + reinterpret_cast<const osmium::memory::Item*>(endpos())->byte_size();
}
return endpos();
}
void set_role_size(string_size_type size) noexcept {
m_role_size = size;
}
public:
static constexpr item_type collection_type = item_type::relation_member_list;
explicit RelationMember(const object_id_type ref = 0, const item_type type = item_type(), const bool full = false) noexcept :
m_ref(ref),
m_type(type),
m_flags(full ? 1 : 0) {
}
RelationMember(const RelationMember&) = delete;
RelationMember& operator=(const RelationMember&) = delete;
RelationMember(RelationMember&&) = delete;
RelationMember& operator=(RelationMember&&) = delete;
~RelationMember() noexcept = default;
object_id_type ref() const noexcept {
return m_ref;
}
unsigned_object_id_type positive_ref() const noexcept {
return static_cast<unsigned_object_id_type>(std::abs(m_ref));
}
RelationMember& set_ref(const osmium::object_id_type ref) noexcept {
m_ref = ref;
return *this;
}
item_type type() const noexcept {
return m_type;
}
bool full_member() const noexcept {
return m_flags == 1;
}
const char* role() const noexcept {
return reinterpret_cast<const char*>(data() + sizeof(RelationMember));
}
OSMObject& get_object() {
return *reinterpret_cast<OSMObject*>(endpos());
}
const OSMObject& get_object() const {
return *reinterpret_cast<const OSMObject*>(endpos());
}
}; // class RelationMember
class RelationMemberList : public osmium::memory::Collection<RelationMember, osmium::item_type::relation_member_list> {
public:
constexpr static bool is_compatible_to(osmium::item_type t) noexcept {
return t == osmium::item_type::relation_member_list ||
t == osmium::item_type::relation_member_list_with_full_members;
}
RelationMemberList() noexcept = default;
}; // class RelationMemberList
class Relation : public OSMObject {
template <typename TDerived, typename T>
friend class osmium::builder::OSMObjectBuilder;
Relation() noexcept :
OSMObject(sizeof(Relation), osmium::item_type::relation) {
}
public:
static constexpr osmium::item_type itemtype = osmium::item_type::relation;
constexpr static bool is_compatible_to(osmium::item_type t) noexcept {
return t == itemtype;
}
RelationMemberList& members() {
return osmium::detail::subitem_of_type<RelationMemberList>(begin(), end());
}
const RelationMemberList& members() const {
return osmium::detail::subitem_of_type<const RelationMemberList>(cbegin(), cend());
}
const RelationMemberList& cmembers() const {
return osmium::detail::subitem_of_type<const RelationMemberList>(cbegin(), cend());
}
}; // class Relation
} // namespace osmium
#endif // OSMIUM_OSM_RELATION_HPP
osmium::OSMObject
Definition object.hpp:64
osmium::RelationMemberList
Definition relation.hpp:147
osmium::RelationMemberList::is_compatible_to
static constexpr bool is_compatible_to(osmium::item_type t) noexcept
Definition relation.hpp:151
osmium::RelationMemberList::RelationMemberList
RelationMemberList() noexcept=default
osmium::RelationMember
Definition relation.hpp:56
osmium::RelationMember::m_role_size
string_size_type m_role_size
Definition relation.hpp:63
osmium::RelationMember::get_object
OSMObject & get_object()
Definition relation.hpp:137
osmium::RelationMember::RelationMember
RelationMember(const RelationMember &)=delete
osmium::RelationMember::~RelationMember
~RelationMember() noexcept=default
osmium::RelationMember::m_ref
object_id_type m_ref
Definition relation.hpp:60
osmium::RelationMember::RelationMember
RelationMember(RelationMember &&)=delete
osmium::RelationMember::next
unsigned char * next()
Definition relation.hpp:76
osmium::RelationMember::role
const char * role() const noexcept
Definition relation.hpp:133
osmium::RelationMember::operator=
RelationMember & operator=(const RelationMember &)=delete
osmium::RelationMember::next
const unsigned char * next() const
Definition relation.hpp:83
osmium::RelationMember::set_ref
RelationMember & set_ref(const osmium::object_id_type ref) noexcept
Definition relation.hpp:120
osmium::RelationMember::type
item_type type() const noexcept
Definition relation.hpp:125
osmium::RelationMember::set_role_size
void set_role_size(string_size_type size) noexcept
Definition relation.hpp:90
osmium::RelationMember::endpos
unsigned char * endpos()
Definition relation.hpp:65
osmium::RelationMember::positive_ref
unsigned_object_id_type positive_ref() const noexcept
Definition relation.hpp:116
osmium::RelationMember::RelationMember
RelationMember(const object_id_type ref=0, const item_type type=item_type(), const bool full=false) noexcept
Definition relation.hpp:98
osmium::RelationMember::collection_type
static constexpr item_type collection_type
Definition relation.hpp:96
osmium::RelationMember::operator=
RelationMember & operator=(RelationMember &&)=delete
osmium::RelationMember::get_object
const OSMObject & get_object() const
Definition relation.hpp:141
osmium::RelationMember::m_flags
uint16_t m_flags
Definition relation.hpp:62
osmium::RelationMember::endpos
const unsigned char * endpos() const
Definition relation.hpp:69
osmium::RelationMember::full_member
bool full_member() const noexcept
Definition relation.hpp:129
osmium::RelationMember::m_type
item_type m_type
Definition relation.hpp:61
osmium::RelationMember::ref
object_id_type ref() const noexcept
Definition relation.hpp:112
osmium::Relation
Definition relation.hpp:161
osmium::Relation::members
RelationMemberList & members()
Get a reference to the member list.
Definition relation.hpp:179
osmium::Relation::Relation
Relation() noexcept
Definition relation.hpp:166
osmium::Relation::cmembers
const RelationMemberList & cmembers() const
Get a const reference to the member list.
Definition relation.hpp:189
osmium::Relation::is_compatible_to
static constexpr bool is_compatible_to(osmium::item_type t) noexcept
Definition relation.hpp:174
osmium::Relation::members
const RelationMemberList & members() const
Get a const reference to the member list.
Definition relation.hpp:184
osmium::builder::OSMObjectBuilder
Definition osm_object_builder.hpp:401
osmium::builder::RelationMemberListBuilder
Definition osm_object_builder.hpp:228
osmium::memory::CollectionIterator
Definition collection.hpp:47
osmium::memory::Collection
Definition collection.hpp:181
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::itemtype
static constexpr osmium::item_type itemtype
Definition collection.hpp:192
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::end
iterator end() noexcept
Definition collection.hpp:224
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::cend
const_iterator cend() const noexcept
Definition collection.hpp:232
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::cbegin
const_iterator cbegin() const noexcept
Definition collection.hpp:228
osmium::memory::Collection< RelationMember, osmium::item_type::relation_member_list >::begin
iterator begin() noexcept
Definition collection.hpp:220
osmium::memory::Item
Definition item.hpp:105
collection.hpp
entity.hpp
item.hpp
item_type.hpp
osmium::memory::padded_length
constexpr std::size_t padded_length(std::size_t length) noexcept
Definition item.hpp:64
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
osmium::object_id_type
int64_t object_id_type
Type for OSM object (node, way, or relation) IDs.
Definition types.hpp:45
osmium::string_size_type
uint16_t string_size_type
Definition types.hpp:59
osmium::item_type
item_type
Definition item_type.hpp:45
osmium::item_type::relation_member_list
@ relation_member_list
osmium::item_type::relation_member_list_with_full_members
@ relation_member_list_with_full_members
osmium::item_type::relation
@ relation
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
object.hpp
types.hpp