openPMD-api
HDF5IOHandler.hpp
1 /* Copyright 2017-2021 Fabian Koller
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * openPMD-api is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 #pragma once
22 
23 #include "openPMD/IO/AbstractIOHandler.hpp"
24 #include "openPMD/auxiliary/JSON_internal.hpp"
25 
26 #include <future>
27 #include <memory>
28 #include <string>
29 
30 namespace openPMD
31 {
32 class HDF5IOHandlerImpl;
33 
35 {
36 public:
37  HDF5IOHandler(std::string path, Access, json::TracingJSON config);
38  ~HDF5IOHandler() override;
39 
40  std::string backendName() const override
41  {
42  return "HDF5";
43  }
44 
45  std::future<void> flush(internal::ParsedFlushParams &) override;
46 
47 private:
48  std::unique_ptr<HDF5IOHandlerImpl> m_impl;
49 }; // HDF5IOHandler
50 } // namespace openPMD
Definition: HDF5IOHandler.hpp:34
Extend nlohmann::json with tracing of which keys have been accessed by operator[]().
Definition: JSON_internal.hpp:67
std::future< void > flush(internal::ParsedFlushParams &) override
Process operations in queue according to FIFO.
Definition: HDF5IOHandler.cpp:2550
Access
File access mode to use during IO.
Definition: Access.hpp:29
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:179
std::string backendName() const override
The currently used backend.
Definition: HDF5IOHandler.hpp:40
Public definitions of openPMD-api.
Definition: FlushParametersInternal.hpp:31