node_ref.hpp

Go to the documentation of this file.

#ifndef OSMIUM_OSM_NODE_REF_HPP
#define OSMIUM_OSM_NODE_REF_HPP
 
/*
 
This file is part of Osmium (https://osmcode.org/libosmium).
 
Copyright 2013-2023 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/item.hpp>
#include <osmium/osm/location.hpp>
#include <osmium/osm/types.hpp>
 
#include <cstdint>
#include <cstdlib>
#include <iosfwd>
 
namespace osmium {
 
    class NodeRef : public osmium::memory::detail::ItemHelper {
 
        osmium::object_id_type m_ref;
        osmium::Location m_location;
 
    public:
 
        constexpr NodeRef(const osmium::object_id_type ref = 0, const osmium::Location& location = Location{}) noexcept : // NOLINT(google-explicit-constructor, hicpp-explicit-conversions)
            m_ref(ref),
            m_location(location) {
        }
 
        constexpr osmium::object_id_type ref() const noexcept {
            return m_ref;
        }
 
        osmium::unsigned_object_id_type positive_ref() const noexcept {
            return static_cast<osmium::unsigned_object_id_type>(std::abs(m_ref));
        }
 
        osmium::Location& location() noexcept {
            return m_location;
        }
 
        constexpr osmium::Location location() const noexcept {
            return m_location;
        }
 
        double lon() const {
            return m_location.lon();
        }
 
        double lat() const {
            return m_location.lat();
        }
 
        constexpr int32_t x() const noexcept {
            return m_location.x();
        }
 
        constexpr int32_t y() const noexcept {
            return m_location.y();
        }
 
        NodeRef& set_ref(const osmium::object_id_type ref) noexcept {
            m_ref = ref;
            return *this;
        }
 
        NodeRef& set_location(const osmium::Location& location) noexcept {
            m_location = location;
            return *this;
        }
 
    }; // class NodeRef
 
    inline constexpr bool operator==(const NodeRef& lhs, const NodeRef& rhs) noexcept {
        return lhs.ref() == rhs.ref();
    }
 
    inline constexpr bool operator!=(const NodeRef& lhs, const NodeRef& rhs) noexcept {
        return !(lhs == rhs);
    }
 
    inline constexpr bool operator<(const NodeRef& lhs, const NodeRef& rhs) noexcept {
        return lhs.ref() < rhs.ref();
    }
 
    inline constexpr bool operator>(const NodeRef& lhs, const NodeRef& rhs) noexcept {
        return rhs < lhs;
    }
 
    inline constexpr bool operator<=(const NodeRef& lhs, const NodeRef& rhs) noexcept {
        return !(rhs < lhs);
    }
 
    inline constexpr bool operator>=(const NodeRef& lhs, const NodeRef& rhs) noexcept {
        return !(lhs < rhs);
    }
 
    template <typename TChar, typename TTraits>
    inline std::basic_ostream<TChar, TTraits>& operator<<(std::basic_ostream<TChar, TTraits>& out, const osmium::NodeRef& nr) {
        return out << "<" << nr.ref() << " " << nr.location() << ">";
    }
 
    struct location_equal {
 
        constexpr bool operator()(const NodeRef& lhs, const NodeRef& rhs) const noexcept {
            return lhs.location() == rhs.location();
        }
 
        using first_argument_type = NodeRef;
        using second_argument_type = NodeRef;
        using result_type = bool;
 
    }; // struct location_equal
 
    struct location_less {
 
        constexpr bool operator()(const NodeRef& lhs, const NodeRef& rhs) const noexcept {
            return lhs.location() < rhs.location();
        }
 
        using first_argument_type = NodeRef;
        using second_argument_type = NodeRef;
        using result_type = bool;
 
    }; // struct location_less
 
} // namespace osmium
 
#endif // OSMIUM_OSM_NODE_REF_HPP