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