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

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

Loading...
Searching...
No Matches
reader_with_progress_bar.hpp
Go to the documentation of this file.
1#ifndef OSMIUM_IO_READER_WITH_PROGRESS_BAR_HPP
2#define OSMIUM_IO_READER_WITH_PROGRESS_BAR_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/io/input_iterator.hpp>
37#include <osmium/io/reader.hpp>
38#include <osmium/memory/buffer.hpp>
39#include <osmium/util/progress_bar.hpp>
40
41namespace osmium {
42
43 namespace io {
44
49 class ReaderWithProgressBar : public Reader {
50
51 ProgressBar m_progress_bar;
52
53 public:
54
62 template <typename... TArgs>
63 explicit ReaderWithProgressBar(bool enable, TArgs&&... args) :
64 Reader(std::forward<TArgs>(args)...),
65 m_progress_bar(file_size(), enable) {
66 }
67
72 osmium::memory::Buffer read() {
73 auto buffer = Reader::read();
74 if (buffer) {
75 m_progress_bar.update(offset());
76 } else {
77 m_progress_bar.done();
78 }
79 return buffer;
80 }
81
83 ProgressBar& progress_bar() noexcept {
84 return m_progress_bar;
85 }
86
87 }; // class ReaderWithProgressBar
88
89 inline InputIterator<ReaderWithProgressBar> begin(ReaderWithProgressBar& reader) {
90 return InputIterator<ReaderWithProgressBar>(reader);
91 }
92
93 inline InputIterator<ReaderWithProgressBar> end(ReaderWithProgressBar& /*reader*/) {
94 return {};
95 }
96
97 } // namespace io
98
99} // namespace osmium
100
101#endif // OSMIUM_IO_READER_WITH_PROGRESS_BAR_HPP
buffer.hpp
osmium::ProgressBar
Definition progress_bar.hpp:46
osmium::io::InputIterator
Definition input_iterator.hpp:55
osmium::io::ReaderWithProgressBar
Definition reader_with_progress_bar.hpp:49
osmium::io::ReaderWithProgressBar::ReaderWithProgressBar
ReaderWithProgressBar(bool enable, TArgs &&... args)
Definition reader_with_progress_bar.hpp:63
osmium::io::ReaderWithProgressBar::progress_bar
ProgressBar & progress_bar() noexcept
Get the underlying ProgressBar object.
Definition reader_with_progress_bar.hpp:83
osmium::io::ReaderWithProgressBar::read
osmium::memory::Buffer read()
Definition reader_with_progress_bar.hpp:72
osmium::io::ReaderWithProgressBar::m_progress_bar
ProgressBar m_progress_bar
Definition reader_with_progress_bar.hpp:51
osmium::io::Reader::read
osmium::memory::Buffer read()
Definition reader.hpp:444
osmium::io::Reader::Reader
Reader(const osmium::io::File &file, TArgs &&... args)
Definition reader.hpp:319
osmium::io::Reader::file_size
std::size_t file_size() const noexcept
Definition reader.hpp:506
osmium::io::Reader::offset
std::size_t offset() const noexcept
Definition reader.hpp:524
input_iterator.hpp
osmium::io
Everything related to input and output of OSM data.
Definition bzip2_compression.hpp:86
osmium::io::end
InputIterator< Reader > end(Reader &)
Definition reader_iterator.hpp:47
osmium::io::begin
InputIterator< Reader > begin(Reader &reader)
Definition reader_iterator.hpp:43
osmium
Namespace for everything in the Osmium library.
Definition assembler.hpp:53
std
Definition location.hpp:654
progress_bar.hpp
reader.hpp