Libosmium: include/osmium/io/header.hpp Source File

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

Loading...
Searching...
No Matches
header.hpp
Go to the documentation of this file.
1#ifndef OSMIUM_IO_HEADER_HPP
2#define OSMIUM_IO_HEADER_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/osm/box.hpp>
37#include <osmium/util/options.hpp>
38
39#include <initializer_list>
40#include <vector>
41
42namespace osmium {
43
44 namespace io {
45
68 class Header : public osmium::Options {
69
71 std::vector<osmium::Box> m_boxes;
72
78 bool m_has_multiple_object_versions = false;
79
80 public:
81
82 Header() = default;
83
84 Header(const std::initializer_list<osmium::Options::value_type>& values) :
85 Options(values) {
86 }
87
91 std::vector<osmium::Box>& boxes() noexcept {
92 return m_boxes;
93 }
94
98 const std::vector<osmium::Box>& boxes() const noexcept {
99 return m_boxes;
100 }
101
105 Header& boxes(const std::vector<osmium::Box>& boxes) noexcept {
106 m_boxes = boxes;
107 return *this;
108 }
109
115 osmium::Box box() const {
116 return m_boxes.empty() ? osmium::Box{} : m_boxes.front();
117 }
118
126 osmium::Box joined_boxes() const {
127 osmium::Box result_box;
128 for (const auto& b : m_boxes) {
129 result_box.extend(b);
130 }
131 return result_box;
132 }
133
140 Header& add_box(const osmium::Box& box) {
141 m_boxes.push_back(box);
142 return *this;
143 }
144
148 bool has_multiple_object_versions() const noexcept {
149 return m_has_multiple_object_versions;
150 }
151
158 Header& set_has_multiple_object_versions(bool value) noexcept {
159 m_has_multiple_object_versions = value;
160 return *this;
161 }
162
163 }; // class Header
164
165 } // namespace io
166
167} // namespace osmium
168
169#endif // OSMIUM_IO_HEADER_HPP
box.hpp
osmium::io::Header::m_has_multiple_object_versions
bool m_has_multiple_object_versions
Definition header.hpp:78
osmium::io::Header::joined_boxes
osmium::Box joined_boxes() const
Definition header.hpp:126
osmium::io::Header::boxes
Header & boxes(const std::vector< osmium::Box > &boxes) noexcept
Definition header.hpp:105
osmium::io::Header::has_multiple_object_versions
bool has_multiple_object_versions() const noexcept
Definition header.hpp:148
osmium::io::Header::boxes
std::vector< osmium::Box > & boxes() noexcept
Definition header.hpp:91
osmium::io::Header::set_has_multiple_object_versions
Header & set_has_multiple_object_versions(bool value) noexcept
Definition header.hpp:158
osmium::io::Header::box
osmium::Box box() const
Definition header.hpp:115
osmium::io::Header::m_boxes
std::vector< osmium::Box > m_boxes
Bounding boxes.
Definition header.hpp:71
osmium::io::Header::add_box
Header & add_box(const osmium::Box &box)
Definition header.hpp:140
osmium::io::Header::Header
Header(const std::initializer_list< osmium::Options::value_type > &values)
Definition header.hpp:84
osmium::io::Header::boxes
const std::vector< osmium::Box > & boxes() const noexcept
Definition header.hpp:98
osmium::io::Header::Header
Header()=default
osmium::Options
Definition options.hpp:58
osmium::io
Everything related to input and output of OSM data.
Definition bzip2_compression.hpp:86
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
options.hpp