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 
25 #include <nlohmann/json.hpp>
26 
27 #include <future>
28 #include <memory>
29 #include <string>
30 
31 namespace openPMD
32 {
33 class HDF5IOHandlerImpl;
34 
36 {
37 public:
38  HDF5IOHandler(std::string path, Access, nlohmann::json config);
39  ~HDF5IOHandler() override;
40 
41  std::string backendName() const override
42  {
43  return "HDF5";
44  }
45 
46  std::future<void> flush(internal::FlushParams const &) override;
47 
48 private:
49  std::unique_ptr<HDF5IOHandlerImpl> m_impl;
50 }; // HDF5IOHandler
51 } // namespace openPMD
Definition: HDF5IOHandler.hpp:35
Access
File access mode to use during IO.
Definition: Access.hpp:27
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:122
std::string backendName() const override
The currently used backend.
Definition: HDF5IOHandler.hpp:41
Public definitions of openPMD-api.
Definition: Date.cpp:28
Parameters recursively passed through the openPMD hierarchy when flushing.
Definition: AbstractIOHandler.hpp:103
std::future< void > flush(internal::FlushParams const &) override
Process operations in queue according to FIFO.
Definition: HDF5IOHandler.cpp:2288