Libosmium: include/osmium/osm/entity.hpp Source File

Libosmium Fast and flexible C++ library for working with OpenStreetMap data

Loading...
Searching...
No Matches
entity.hpp
Go to the documentation of this file.
1#ifndef OSMIUM_OSM_ENTITY_HPP
2#define OSMIUM_OSM_ENTITY_HPP
3
4/*
5
6This file is part of Osmium (https://osmcode.org/libosmium).
7
8Copyright 2013-2026 Jochen Topf <jochen@topf.org> and others (see README).
9
10Boost Software License - Version 1.0 - August 17th, 2003
11
12Permission is hereby granted, free of charge, to any person or organization
13obtaining a copy of the software and accompanying documentation covered by
14this license (the "Software") to use, reproduce, display, distribute,
15execute, and transmit the Software, and to prepare derivative works of the
16Software, and to permit third-parties to whom the Software is furnished to
17do so, all subject to the following:
18
19The copyright notices in the Software and this entire statement, including
20the above license grant, this restriction and the following disclaimer,
21must be included in all copies of the Software, in whole or in part, and
22all derivative works of the Software, unless such copies or derivative
23works are solely in the form of machine-executable object code generated by
24a source language processor.
25
26THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
27IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
28FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
29SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
30FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
31ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
32DEALINGS IN THE SOFTWARE.
33
34*/
35
36#include <osmium/memory/item.hpp>
37#include <osmium/osm/entity_bits.hpp>
38#include <osmium/osm/item_type.hpp>
39
40namespace osmium {
41
42 namespace detail {
43
44 template <typename TSubitem, typename TIter>
45 inline TSubitem& subitem_of_type(TIter it, const TIter& end) {
46 for (; it != end; ++it) {
47 if (TSubitem::is_compatible_to(it->type()) && !it->removed()) {
48 return reinterpret_cast<TSubitem&>(*it);
49 }
50 }
51
52 // If no subitem of the TSubitem type was found,
53 // return a default constructed one.
54 static TSubitem subitem;
55 return subitem;
56 }
57
58 } // namespace detail
59
64 class OSMEntity : public osmium::memory::Item {
65
66 public:
67
68 constexpr static bool is_compatible_to(osmium::item_type t) noexcept {
69 return t == osmium::item_type::node ||
70 t == osmium::item_type::way ||
71 t == osmium::item_type::relation ||
72 t == osmium::item_type::area ||
73 t == osmium::item_type::changeset;
74 }
75
76 explicit OSMEntity(osmium::memory::item_size_type size, osmium::item_type type) :
77 Item(size, type) {
78 }
79
80 bool type_is_in(osmium::osm_entity_bits::type entity_bits) const {
81 return (osm_entity_bits::from_item_type(type()) & entity_bits) != 0;
82 }
83
84 }; // class OSMEntity
85
86} // namespace osmium
87
88#endif // OSMIUM_OSM_ENTITY_HPP
osmium::OSMEntity::type_is_in
bool type_is_in(osmium::osm_entity_bits::type entity_bits) const
Definition entity.hpp:80
osmium::OSMEntity::is_compatible_to
static constexpr bool is_compatible_to(osmium::item_type t) noexcept
Definition entity.hpp:68
osmium::OSMEntity::OSMEntity
OSMEntity(osmium::memory::item_size_type size, osmium::item_type type)
Definition entity.hpp:76
osmium::memory::Item
Definition item.hpp:105
osmium::memory::Item::type
item_type type() const noexcept
Definition item.hpp:171
osmium::memory::Item::Item
Item(item_size_type size=0, item_type type=item_type{}) noexcept
Definition item.hpp:128
entity_bits.hpp
item.hpp
item_type.hpp
osmium::io::end
InputIterator< Reader > end(Reader &)
Definition reader_iterator.hpp:47
osmium::memory::item_size_type
uint32_t item_size_type
Definition item.hpp:57
osmium::osm_entity_bits::type
type
Definition entity_bits.hpp:65
osmium::osm_entity_bits::from_item_type
type from_item_type(osmium::item_type item_type) noexcept
Definition entity_bits.hpp:119
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
osmium::item_type
item_type
Definition item_type.hpp:45
osmium::item_type::relation
@ relation
Definition item_type.hpp:50
osmium::item_type::node
@ node
Definition item_type.hpp:48
osmium::item_type::changeset
@ changeset
Definition item_type.hpp:52
osmium::item_type::area
@ area
Definition item_type.hpp:51
osmium::item_type::way
@ way
Definition item_type.hpp:49