openPMD-api
JSONIOHandler.hpp
1 /* Copyright 2017-2021 Franz Poeschel
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 
22 #pragma once
23 
24 #include "openPMD/IO/AbstractIOHandler.hpp"
25 #include "openPMD/IO/JSON/JSONIOHandlerImpl.hpp"
26 
27 namespace openPMD
28 {
30 {
31 public:
32  JSONIOHandler(std::string path, Access at);
33 
34  ~JSONIOHandler() override;
35 
36  std::string backendName() const override
37  {
38  return "JSON";
39  }
40 
41  std::future<void> flush(internal::FlushParams const &) override;
42 
43 private:
44  JSONIOHandlerImpl m_impl;
45 };
46 } // namespace openPMD
std::future< void > flush(internal::FlushParams const &) override
Process operations in queue according to FIFO.
Definition: JSONIOHandler.cpp:32
Access
File access mode to use during IO.
Definition: Access.hpp:27
Definition: JSONIOHandlerImpl.hpp:151
Definition: JSONIOHandler.hpp:29
Interface for communicating between logical and physically persistent data.
Definition: AbstractIOHandler.hpp:122
Public definitions of openPMD-api.
Definition: Date.cpp:28
Parameters recursively passed through the openPMD hierarchy when flushing.
Definition: AbstractIOHandler.hpp:103
std::string backendName() const override
The currently used backend.
Definition: JSONIOHandler.hpp:36