problem_reporter.hpp

Go to the documentation of this file.

#ifndef OSMIUM_AREA_PROBLEM_REPORTER_HPP
#define OSMIUM_AREA_PROBLEM_REPORTER_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/osm/item_type.hpp>
#include <osmium/osm/location.hpp>
#include <osmium/osm/types.hpp>
 
#include <cstddef>
 
namespace osmium {
 
    class NodeRef;
    class Way;
 
    namespace area {
 
        class ProblemReporter {
 
        protected:
 
            // Type of object we are currently working on
            osmium::item_type m_object_type = osmium::item_type::undefined;
 
            // ID of the relation/way we are currently working on
            osmium::object_id_type m_object_id = 0;
 
            // Number of nodes in the area
            size_t m_nodes = 0;
 
        public:
 
            ProblemReporter() = default;
 
            ProblemReporter(const ProblemReporter&) = default;
            ProblemReporter& operator=(const ProblemReporter&) = default;
 
            ProblemReporter(ProblemReporter&&) noexcept = default;
            ProblemReporter& operator=(ProblemReporter&&) noexcept = default;
 
            virtual ~ProblemReporter() noexcept = default;
 
            void set_object(osmium::item_type object_type, osmium::object_id_type object_id) noexcept {
                m_object_type = object_type;
                m_object_id = object_id;
            }
 
            osmium::object_id_type object_id() const noexcept {
                return m_object_id;
            }
 
            void set_nodes(size_t nodes) noexcept {
                m_nodes = nodes;
            }
 
// Disable "unused-parameter" warning, so that the compiler will not complain.
// We can't remove the parameter names, because then doxygen will complain.
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
 
            virtual void report_duplicate_node(osmium::object_id_type node_id1, osmium::object_id_type node_id2, osmium::Location location) {
            }
 
            virtual void report_touching_ring(osmium::object_id_type node_id, osmium::Location location) {
            }
 
            virtual void report_intersection(osmium::object_id_type way1_id, osmium::Location way1_seg_start, osmium::Location way1_seg_end,
                                             osmium::object_id_type way2_id, osmium::Location way2_seg_start, osmium::Location way2_seg_end, osmium::Location intersection) {
            }
 
            virtual void report_duplicate_segment(const osmium::NodeRef& nr1, const osmium::NodeRef& nr2) {
            }
 
            virtual void report_overlapping_segment(const osmium::NodeRef& nr1, const osmium::NodeRef& nr2) {
            }
 
            virtual void report_ring_not_closed(const osmium::NodeRef& nr, const osmium::Way* way) {
            }
 
            virtual void report_role_should_be_outer(osmium::object_id_type way_id, osmium::Location seg_start, osmium::Location seg_end) {
            }
 
            virtual void report_role_should_be_inner(osmium::object_id_type way_id, osmium::Location seg_start, osmium::Location seg_end) {
            }
 
            virtual void report_way_in_multiple_rings(const osmium::Way& way) {
            }
 
            virtual void report_inner_with_same_tags(const osmium::Way& way) {
            }
 
            virtual void report_invalid_location(osmium::object_id_type way_id, osmium::object_id_type node_id) {
            }
 
            virtual void report_duplicate_way(const osmium::Way& way) {
            }
 
            virtual void report_way(const osmium::Way& way) {
            }
 
#pragma GCC diagnostic pop
 
        }; // class ProblemReporter
 
    } // namespace area
 
} // namespace osmium
 
#endif // OSMIUM_AREA_PROBLEM_REPORTER_HPP